BMGetButtonDetails API operation (SOAP)

Important: NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, we recommend our latest solutions.

Shows information about a hosted PayPal Payments Standard button.

Important:

The Button Manager API is deprecated. For new integrations, see the associated topic.

Button, See
Button	See
Buy Now	PayPal Checkout Overview
Add to Cart	Solution Providers
Donate	Create a Donate button
Automatic Billing Subscribe	Subscriptions Overview

You can use this information to set the fields that have not changed when you update a button.

BMGetButtonDetails request

The request includes the ID of the hosted button for which to get details.

BMGetButtonDetails request parameters

Field, Description
Field	Description
`HostedButtonID`	`xs:string` (Required) The ID of the hosted button whose details you want to obtain.

BMGetButtonDetails response

The response fields contain all non-inventory information related to the button.

BMGetButtonDetails response fields

Field, Description
Field	Description
`ButtonType`	`ebl:ButtonTypeType` The kind of button. Value is: `BUYNOW`. The Buy Now button. `CART`. The Add to Cart button. `SUBSCRIBE`. The Subscribe button. `DONATE`. The Donate button. `UNSUBSCRIBE`. The Unsubscribe button. `VIEWCART`. The View Cart button. `AUTOBILLING`. The Automatic Billing button. Since version 63.0.
`ButtonCode`	`ebl:ButtonCodeType` The kind of button code. Value is: `HOSTED`. A secure button stored on PayPal. `ENCRYPTED`. An encrypted button, not stored on PayPal. `CLEARTEXT`. An unencrypted button, not stored on PayPal.
`ButtonSubType`	`ebl:ButtonSubTypeType` The use of button. Value is: `PRODUCTS`. The button is used to purchase products. `SERVICES`. The button to purchase services.
`HostedButtonID`	`xs:string` The ID of a PayPal-hosted button.
`Website`	`xs:string` HTML code for web pages
`Email`	`xs:string` Code for email links and links in other documents that support external links
`ButtonVar`	`xs:string` HTML standard button variables

Option details fields

Field, Description
Field	Description
`OptionName`	`xs:string` (Optional) The menu name.
`OptionSelectionDetails`	`ns:OptionSelectionDetailsType` (Optional) Menu items.

Option selection details fields

Field, Description
Field	Description
`OptionSelection`	`xs:string` (Optional) The menu item's name
`Price`	`xs:string` (Optional) The price associated with the first menu item. Note: If you specify a price, you cannot set a button variable to `amount`.

BMGetButtonDetails errors

Error code, Short and long messages, User action
Error code	Short and long messages	User action
10001	Internal Error Internal Error	To learn more about possible causes and corrective actions, see What is API error code 10001?.
11950	Invalid Data A hosted button ID must be specified.
11951	Invalid Argument The hosted button ID specified is invalid.
11951	Operation Refused Operation not supported for Sample Buttons.
11992	Invalid Argument You do not have permissions to access this button. Verify the hosted button ID and try the request again.

Button

See

Buy Now

PayPal Checkout Overview

Add to Cart

Solution Providers

Donate

Create a Donate button

Automatic Billing
Subscribe

Subscriptions Overview

Field

Description

HostedButtonID

xs:string
(Required) The ID of the hosted button whose details you want to obtain.

BMGetButtonDetails response

The response fields contain all non-inventory information related to the button.

Field, Description
Field	Description
`ButtonType`	`ebl:ButtonTypeType` The kind of button. Value is: `BUYNOW`. The Buy Now button. `CART`. The Add to Cart button. `SUBSCRIBE`. The Subscribe button. `DONATE`. The Donate button. `UNSUBSCRIBE`. The Unsubscribe button. `VIEWCART`. The View Cart button. `AUTOBILLING`. The Automatic Billing button. Since version 63.0.
`ButtonCode`	`ebl:ButtonCodeType` The kind of button code. Value is: `HOSTED`. A secure button stored on PayPal. `ENCRYPTED`. An encrypted button, not stored on PayPal. `CLEARTEXT`. An unencrypted button, not stored on PayPal.
`ButtonSubType`	`ebl:ButtonSubTypeType` The use of button. Value is: `PRODUCTS`. The button is used to purchase products. `SERVICES`. The button to purchase services.
`HostedButtonID`	`xs:string` The ID of a PayPal-hosted button.
`Website`	`xs:string` HTML code for web pages
`Email`	`xs:string` Code for email links and links in other documents that support external links
`ButtonVar`	`xs:string` HTML standard button variables

Field, Description
Field	Description
`OptionName`	`xs:string` (Optional) The menu name.
`OptionSelectionDetails`	`ns:OptionSelectionDetailsType` (Optional) Menu items.

Field, Description
Field	Description
`OptionSelection`	`xs:string` (Optional) The menu item's name
`Price`	`xs:string` (Optional) The price associated with the first menu item. Note: If you specify a price, you cannot set a button variable to `amount`.

BMGetButtonDetails errors

Error code, Short and long messages, User action
Error code	Short and long messages	User action
10001	Internal Error Internal Error	To learn more about possible causes and corrective actions, see What is API error code 10001?.
11950	Invalid Data A hosted button ID must be specified.
11951	Invalid Argument The hosted button ID specified is invalid.
11951	Operation Refused Operation not supported for Sample Buttons.
11992	Invalid Argument You do not have permissions to access this button. Verify the hosted button ID and try the request again.

BMGetButtonDetails API operation (SOAP)