BMGetButtonDetails API Operation (SOAP)
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 Buy Now
Add to Cart
Donate
Automatic Billing
Subscribe
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 |
|---|---|
|
|
(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 |
||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
The kind of button. Value is:
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
The kind of button code. Value is:
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
The use of button. Value is:
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
The ID of a PayPal-hosted button. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
HTML code for web pages |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Code for email links and links in other documents that support external links |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
HTML standard button variables |
Option details fields
|
Field |
Description |
|---|---|
|
|
(Optional) The menu name. |
|
|
(Optional) Menu items. |
Option selection details fields
|
|
(Optional) The menu item's name |
|
|
(Optional) The price associated with the first menu item. Note: If you specify a price, you cannot set a button variable to
|
BMGetButtonDetails errors
| 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. |
