BMGetButtonDetails API Operation (SOAP)

Use the BMGetButtonDetails API operation to obtain information about a hosted PayPal Payments Standard button. You can use this information to set the fields that have not changed when updating a button.

BMGetButtonDetails Request

The request includes only the ID of the hosted button whose details you want to obtain.

BMGetButtonDetails Request Fields

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.

OptionsDetailsType Diagram

OptionSelectionDetailsType Diagram

BMGetButtonDetails Response Fields

Field

Description

ButtonType

ebl:ButtonTypeType

The kind of button. It is one of the following values:


  • BUYNOW - Buy Now button

  • CART - Add to Cart button

  • GIFTCERTIFICATE - Gift Certificate button

  • SUBSCRIBE - Subscribe button

  • DONATE - Donate button

  • UNSUBSCRIBE - Unsubscribe button

  • VIEWCART - View Cart button

  • PAYMENTPLAN - Installment Plan button; since version 63.0

  • AUTOBILLING - Automatic Billing button; since version 63.0

ButtonCode

ebl:ButtonCodeType

The kind of button code. It is one of the following values:


  • 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. It is one of the following values:


  • PRODUCTS - button is used to purchase products

  • SERVICES - button is used to purchase services

HostedButtonID

xs:string

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

OptionName

xs:string

(Optional) The menu name

OptionSelectionDetails

ns:OptionSelectionDetailsType

(Optional) Menu items

Option Selection Details Fields

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.

OptionType

ebl:OptionTypeListType

(Optional) The installment option type for an OPTIONnNAME, which is one of the following values:


  • FULL - Payment in full

  • VARIABLE - Variable installments

  • EMI - Equal installments

Note: Only available for Installment Plan buttons.

PaymentPeriod

ns:InstallmentDetailsType

(Optional) Information about an installment option

Installment Details

BillingPeriod

ebl:BillingPeriodType

(Optional) The installment cycle unit, which is one of the following values:


  • NoBillingPeriodType - None (default)

  • Day

  • Week

  • SemiMonth

  • Month

  • Year

BillingFrequency

xs:int

(Optional) The installment cycle frequency in units, e.g. if the billing frequency is 2 and the billing period is Month, the billing cycle is every 2 months. The default billing frequency is 1.

TotalBillingCycles

xs:int

(Optional) The total number of billing cycles, regardless of the duration of a cycle; 1 is the default

Amount

xs:string

(Optional) The base amount to bill for the cycle.

ShippingAmount

xs:string

(Optional) The shipping amount to bill for the cycle, in addition to the base amount.

TaxAmount

xs:string

(Optional) The tax amount to bill for the cycle, in addition to the base amount.

BMGetButtonDetails Errors

Error Code

Short Message

Long Message

Correcting This Error...

10001 Internal Error Internal Error
11950 Invalid Data A hosted button ID must be specified.
11951 Invalid Argument The hosted button ID specified is invalid.
11951 Invalid Argument The hosted button ID specified is invalid.
11992 Invalid Argument You do not have permissions to access this button. Please check the hosted button ID and try again.