BMButtonSearch API Operation (NVP)

APIDeprecatedLast updated: December 4th 2023, @ 6:19:30 am


Lists your hosted PayPal Payments Standard buttons.

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

Subscribe

Subscriptions Overview

BMButtonSearch request

The request contains optional fields that are not currently used. All hosted buttons are automatically requested.

BMButtonSearch request parameters

Field

Description

METHOD

(Required) BMButtonSearch

STARTDATE

(Required) Starting date for the search. The value must be in UTC/GMT format. For example, 2012-08-24T05:38:48Z. No wild cards are allowed.

ENDDATE

(Optional) Ending date for the search. The value must be in UTC/GMT format. For example, 2013-05-01T05:38:48Z. No wild cards are allowed.

BMButtonSearch response

The response lists all hosted buttons and their associated characteristics.

BMButtonSearch response fields

L_HOSTEDBUTTONIDn

The hosted button ID

Lists variables, where n is a digit between 0 and 9, inclusive.

L_BUTTONTYPEn

The hosted button ID

Lists variables, where n is a digit between 0 and 9, inclusive.

L_ITEMNAMEn

The item name

Lists variables, where n is a digit between 0 and 9, inclusive.

L_MODIFYDATEn

The date created or last changed

Lists variables, where n is a digit between 0 and 9, inclusive.

BMButtonSearch errors

Error codeShort and long messagesUser action
10001Internal Error
Internal Error
To learn more about possible causes and corrective actions, see What is API error code 10001?.
11994Search Warning
You have exceeded the maximum number of buttons that can be returned. If required, adjust your search parameters.
11997Invalid Argument
You must specify a start date.
11998Invalid Argument
The start date is invalid.
11999Invalid Argument
The end date is invalid.