Payment Experience Web Profiles (1)

Use the Payment Experience API to create seamless payment experience profiles. For information about how to create a PayPal payment with a web experience profile, see Web experience profiles.

Create web experience profile

post/v1/payment-experience/web-profiles

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

SecurityOauth2
Request
header Parameters
PayPal-Request-Id
required
string

The server stores keys for three hours.

Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Content-Type
required
string

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

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

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

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.

object (Flow Configuration)

The flow configuration parameters.

object (Input Field Customization)

The input field customization parameters.

object (Style and Presentation)

The style and presentation parameters.

Responses
201

A successful request, with or without the optional PayPal-Request-Id request header, returns the HTTP 201 Created status code and a JSON response body that shows the profile details and the ID of the profile. Any subsequent calls with the same PayPal-Request-Id request header value within a three-hour window returns the HTTP 200 OK status code and a JSON response body that shows the profile details and the ID of the profile.

Request samples
application/json
{}
Response samples
application/json
{
  • "id": "XP-RFV4-PVD8-AGHJ-8E5J",
  • "name": "exampleProfile",
  • "temporary": false,
  • "presentation": {},
  • "input_fields": {
    • "no_shipping": 1,
    • "address_override": 1
    },
  • "flow_config": {}
}

List web experience profiles

get/v1/payment-experience/web-profiles

Lists the latest 20 web experience profiles for a merchant or subject. To show details for these or additional profiles, you can show web experience profile details by ID.

SecurityOauth2
Request
header Parameters
Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Content-Type
required
string

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

Responses
200

A successful request returns the HTTP 200 OK status code and a JSON response body that lists the latest 20 profiles that the merchant owns, with details. To show details for these or additional profiles, you can show web experience profile details by ID.

Request samples 
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payment-experience/web-profiles \
-H 'Authorization: Bearer ECvJ_yBNz_UfMmCvWEbT_2ZWXdzbFFQZ-1Y5K2NGgeHn'
Response samples
application/json
[]

Update web experience profile

put/v1/payment-experience/web-profiles/{id}

Updates a web experience profile, by ID. In the JSON request body, specify the profile details. If your request omits any profile parameters, any previously set values for those parameters are removed.

SecurityOauth2
Request
path Parameters
id
required
string

The ID of the profile to update.

header Parameters
Content-Type
required
string

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

Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Request Body schema: application/json
name
required
string [ 1 .. 50 ] characters

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

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.

object (Flow Configuration)

The flow configuration parameters.

object (Input Field Customization)

The input field customization parameters.

object (Style and Presentation)

The style and presentation parameters.

Responses
204

A successful request returns the HTTP 204 No Content status code with no JSON response body.

Request samples
application/json
{}

Partially update web experience profile

patch/v1/payment-experience/web-profiles/{id}

Partially-updates a web experience profile, by ID. In the JSON request body, specify a patch object, the path of the profile location to update, and a new value.

SecurityOauth2
Request
path Parameters
id
required
string

The ID of the profile to partially update.

header Parameters
Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Content-Type
required
string

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

Request Body schema: application/json
Array
op
required
string

The operation.

Enum: Description
add

Depending on the target location reference, completes one of these functions:

  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.

remove

Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.

replace

Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.

move

Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.

copy

Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.

test

Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.

path
string

The JSON Pointer to the target document location at which to complete the operation.

value
object (Patch Value)

The value to apply. The remove operation does not require a value.

from
string

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

Responses
204

A successful request returns the HTTP 204 No Content status code with no JSON response body.

Request samples
application/json
[
  • {
    • "op": "add",
    • "path": "/presentation/brand_name",
    • "value": "new_brand_name"
    },
  • {
    • "op": "remove",
    • "path": "/flow_config/landing_page_type"
    }
]

Show web experience profile details by ID

get/v1/payment-experience/web-profiles/{id}

Shows details for a web experience profile, by ID.

SecurityOauth2
Request
path Parameters
id
required
string

The ID of the profile for which to show details.

header Parameters
Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Content-Type
required
string

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

Responses
200

A successful request returns the HTTP 200 OK status code and a JSON response body that shows the profile details.

Request samples 
curl -v -X GET https://api-m.sandbox.paypal.com/v1/payment-experience/web-profiles/XP-RFV4-PVD8-AGHJ-8E5J \
-H 'Authorization: Bearer ECvJ_yBNz_UfMmCvWEbT_2ZWXdzbFFQZ-1Y5K2NGgeHn'
Response samples
application/json
{}

Delete web experience profile

delete/v1/payment-experience/web-profiles/{id}

Deletes a web experience profile, by ID.

SecurityOauth2
Request
path Parameters
id
required
string

The ID of the profile to delete.

header Parameters
Authorization
required
string

To make REST API calls, include the bearer token in the Authorization header with the Bearer authentication scheme. The value is Bearer <Access-Token> or Basic <client_id>:<secret>.

Content-Type
required
string

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

Responses
204

A successful request returns the HTTP 204 No Content status code with no JSON response body.

Request samples 
curl -v -X DELETE https://api-m.sandbox.paypal.com/v1/payment-experience/web-profiles/XP-A88A-LYLW-8Y3X-E5ER \
-H 'Authorization: Bearer ECvJ_yBNz_UfMmCvWEbT_2ZWXdzbFFQZ-1Y5K2NGgeHn'

Errors

DUPLICATE_REQUEST_ID

The value of the PayPal-Request-ID header has already been used. The PayPal-Request-ID header contains a duplicate request ID.

INTERNAL_SERVICE_ERROR

An internal service error has occurred. The request failed due to an internal server error.

INVALID_RESOURCE_ID

Invalid profile ID passed. The profile ID is not valid.

MALFORMED_REQUEST

The JSON request does not map to the expected resource. The resource in the request is not valid.

PERMISSION_DENIED

No permission for the requested operation. The caller does not have permission to complete this request.

VALIDATION_ERROR

Invalid data passed. More details can be found in the details array.

WRONG_PATCH

The provided patch has errors. More details can be found in the details array.

Definitions

Error

The error information.

name
required
string

The human-readable, unique name of the error.

debug_id
string

The PayPal internal ID. Used for correlation purposes.

message
required
string

The message that describes the error.

information_link
required
string

The URI to detailed information related to this error for the developer.

Array of objects (Error Details)

An array of additional details for the error.

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

Error Details

The error details. Required for client-side 4XX errors.

field
required
string

The name of the field that caused the error.

issue
required
string

The reason for the error.

{
  • "field": "string",
  • "issue": "string"
}

Patch

The JSON patch object to apply partial updates to resources.

op
required
string

The operation.

Enum: Description
add

Depending on the target location reference, completes one of these functions:

  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.

remove

Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.

replace

Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.

move

Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.

copy

Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.

test

Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.

path
string

The JSON Pointer to the target document location at which to complete the operation.

value
object (Patch Value)

The value to apply. The remove operation does not require a value.

from
string

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

{
  • "op": "add",
  • "path": "string",
  • "value": { },
  • "from": "string"
}

Patch Request

An array of JSON patch objects to apply partial updates to resources.

Array
op
required
string

The operation.

Enum: Description
add

Depending on the target location reference, completes one of these functions:

  • The target location is an array index. Inserts a new value into the array at the specified index.
  • The target location is an object parameter that does not already exist. Adds a new parameter to the object.
  • The target location is an object parameter that does exist. Replaces that parameter's value.
The value parameter defines the value to add. For more information, see 4.1. add.

remove

Removes the value at the target location. For the operation to succeed, the target location must exist. For more information, see 4.2. remove.

replace

Replaces the value at the target location with a new value. The operation object must contain a value parameter that defines the replacement value. For the operation to succeed, the target location must exist. For more information, see 4.3. replace.

move

Removes the value at a specified location and adds it to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to move the value. For the operation to succeed, the from location must exist. For more information, see 4.4. move.

copy

Copies the value at a specified location to the target location. The operation object must contain a from parameter, which is a string that contains a JSON pointer value that references the location in the target document from which to copy the value. For the operation to succeed, the from location must exist. For more information, see 4.5. copy.

test

Tests that a value at the target location is equal to a specified value. The operation object must contain a value parameter that defines the value to compare to the target location's value. For the operation to succeed, the target location must be equal to the value value. For test, equal indicates that the value at the target location and the value that value defines are of the same JSON type. The data type of the value determines how equality is defined:

TypeConsidered equal if both values
stringsContain the same number of Unicode characters and their code points are byte-by-byte equal.
numbersAre numerically equal.
arraysContain the same number of values, and each value is equal to the value at the corresponding position in the other array, by using these type-specific rules.
objectsContain the same number of parameters, and each parameter is equal to a parameter in the other object, by comparing their keys (as strings) and their values (by using these type-specific rules).
literals (false, true, and null)Are the same. The comparison is a logical comparison. For example, whitespace between the parameter values of an array is not significant. Also, ordering of the serialization of object parameters is not significant.
For more information, see 4.6. test.

path
string

The JSON Pointer to the target document location at which to complete the operation.

value
object (Patch Value)

The value to apply. The remove operation does not require a value.

from
string

The JSON Pointer to the target document location from which to move the value. Required for the move operation.

[
  • {
    • "op": "add",
    • "path": "string",
    • "value": { },
    • "from": "string"
    }
]

web_profile

A payment web experience profile.

id
string = 22 characters

The ID of the web experience profile.

name
required
string [ 1 .. 50 ] characters

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

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.

object (Flow Configuration)

The flow configuration parameters.

object (Input Field Customization)

The input field customization parameters.

object (Style and Presentation)

The style and presentation parameters.

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

web_profile_list

An array of web profiles.

Array ([ 1 .. 20 ] items)
id
string = 22 characters

The ID of the web experience profile.

name
required
string [ 1 .. 50 ] characters

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

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.

object (Flow Configuration)

The flow configuration parameters.

object (Input Field Customization)

The input field customization parameters.

object (Style and Presentation)

The style and presentation parameters.

[
  • {
    • "id": "stringstringstringstri",
    • "name": "string",
    • "temporary": true,
    • "flow_config": {
      • "landing_page_type": "string",
      • "bank_txn_pending_url": "http://example.com",
      • "user_action": "string",
      • "return_uri_http_method": "string"
      },
    • "input_fields": {
      • "no_shipping": 2,
      • "address_override": 1
      },
    • "presentation": {
      • "brand_name": "string",
      • "logo_image": "string",
      • "locale_code": "strin"
      }
    }
]