BMButtonSearch API Operation (SOAP)

Use the BMButtonSearch API operation to obtain a list of your hosted PayPal Payments Standard buttons.

BMButtonSearch Request

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

BMButtonSearch Request Fields

Field

Description

StartDate

xs:dateTime

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

EndDate

xs:dateTime

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

BMButtonSearch Response

The response contains a list of all hosted buttons and their associated characteristics.

BMButtonSearch Response Fields

Name

Description

 

ebl:ButtonSearchResult

Search results

Table 1. ButtonSearchResult

HostedButtonID

xs:string

The hosted button ID

HButtonType

xs:string

The hosted button ID

ItemName

xs:string

The item name

ModifyDate

xs:dateTime

The date created or last changed

BMButtonSearch Errors

Error Code

Short Message

Long Message

Correcting This Error...

10001 Internal Error Internal Error
11994 Search Warning You have exceeded the maximum number of buttons that can be returned. Please adjust your search parameters if required.
11997 Invalid Argument A start date value must be specified.
11998 Invalid Argument The start date specified is invalid.
11999 Invalid Argument The end date specified is invalid.