BMGetButtonDetails API Operation (NVP)

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

METHOD

(Required) BMGetButtonDetails

HOSTEDBUTTONID

(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

BUTTONTYPE

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

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

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

ID of a PayPal hosted button

WEBSITECODE

HTML code for web pages

EMAILLINK

Code for email links and links in other documents that support external links

L_BUTTONVARn

HTML standard button variables

Option Details Fields

Field

Description

OPTIONnNAME

(Optional) The menu name

It is one or more variables, in which n is a digit between 0 and 4, inclusive, for hosted buttons; otherwise, it is a digit between 0 and 9, inclusive.

Option Selection Details Fields

L_OPTIONnSELECTx

(Optional) The menu item's name

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 9, inclusive

L_OPTION0PRICEx

(Optional) The price associated with the first menu item

It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 9, inclusive

Note: If you specify a price, you cannot set a button variable to amount.

OPTIONnTYPE

(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.

Installment Details

L_OPTIONnBILLINGPERIODx

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


  • NoBillingPeriodType - None (default)

  • Day

  • Week

  • SemiMonth

  • Month

  • Year

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 4, inclusive

L_OPTIONnBILLINGPFREQUENCYx

(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.

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 4, inclusive

L_OPTIONnTOTALBILLINGCYCLESx

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

It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 4, inclusive

L_OPTIONnAMOUNTx

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

It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 4, inclusive

L_OPTIONnSHIPPINGAMOUNTx

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

It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 4, inclusive

L_OPTIONnTAXAMOUNTx

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

It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 4, inclusive

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.