BMGetButtonDetails API Operation (NVP)

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

PayPal Checkout Overview

Add to Cart

Solution Providers

Donate

Create a Donate button

Automatic Billing

Installment Plan

Subscribe

Subscriptions Overview

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 parameters

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. Value is:


BUTTONCODE

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

The use of button. Value is:


  • PRODUCTS. The button is used to purchase products.

  • SERVICES. The button 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, such as if the billing frequency is 2 and the billing period is Month, the billing cycle is every two 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. The default is 1.

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