PayPal Button Manager API (NVP)
PayPal Button Manager API (NVP) PayPal Button Manager API (NVP)
3Button Manager API ReferenceBMButtonSearch API Operation• BMButtonSearch Request• BMButtonSearch Response• BMButtonSearch ErrorsBMButtonSearch RequestThe request contains optional fields that are not currently used. All hosted buttons areautomatically requested.BMButtonSearch Request FieldsFieldMETHODSTARTDATEENDDATEDescription(Required) BMButtonSearch(Required) Starting date for the search. The value must be in UTC/GMTformat; for example, 2009-08-24T05:38:48Z. No wildcards are allowed.(Optional) Ending date for the search. The value must be in UTC/GMTformat; for example, 2010-05-01T05:38:48Z. No wildcards are allowed.BMButtonSearch ResponseThe response contains a list of all hosted buttons and their associated characteristics.BMButtonSearch Response FieldsFieldL_HOSTEDBUTTONIDnL_BUTTONTYPEnL_ITEMNAMEnL_MODIFYDATEnDescriptionThe hosted button IDIt is a list of variables, in which n is a digit between 0 and 9, inclusive.The hosted button IDIt is a list of variables, in which n is a digit between 0 and 9, inclusive.The item nameIt is a list of variables, in which n is a digit between 0 and 9, inclusive.The date created or last changedIt is a list of variables, in which n is a digit between 0 and 9, inclusive.36 April 2012 Button Manager NVP API
Button Manager API ReferenceBMGetButtonDetails API Operation3BMButtonSearch ErrorsErrorCode Short Message Long Message Correcting This Error...10001 Internal Error Internal Error11994 Search Warning You have exceeded the maximum numberof buttons that can be returned. Pleaseadjust your seach 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.BMGetButtonDetails API OperationUse the BMGetButtonDetails API operation to obtain information about a hosted PayPalPayments Standard button. You can use this information to set the fields that have not changedwhen updating a button.• BMGetButtonDetails Request• BMGetButtonDetails Response• BMUpdateButton ErrorsBMGetButtonDetails RequestThe request includes only the ID of the hosted button whose details you want to obtain.BMGetButtonDetails Request FieldsFieldMETHODHOSTEDBUTTONIDDescription(Required) BMGetButtonDetails(Required) The ID of the hosted button whose details you want to obtain.Button Manager NVP API April 2012 37
- Page 1 and 2: Button Manager API(NVP)Last updated
- Page 3 and 4: ContentsPreface . . . . . . . . . .
- Page 5 and 6: PrefaceThis document describes the
- Page 7 and 8: 1PayPal Payments StandardButton Man
- Page 9 and 10: PayPal Payments Standard Button Man
- Page 11 and 12: PayPal Payments Standard Button Man
- Page 13 and 14: PayPal Payments Standard Button Man
- Page 15 and 16: 2Using the Button Manager APIWith N
- Page 17 and 18: Using the Button Manager API With N
- Page 19 and 20: Using the Button Manager API With N
- Page 21 and 22: Using the Button Manager API With N
- Page 23 and 24: 3Button Manager API ReferenceThe Bu
- Page 25 and 26: Button Manager API ReferenceBMCreat
- Page 27 and 28: Button Manager API ReferenceBMCreat
- Page 29 and 30: Button Manager API ReferenceBMUpdat
- Page 31 and 32: Button Manager API ReferenceBMUpdat
- Page 33 and 34: Button Manager API ReferenceBMUpdat
- Page 35: Button Manager API ReferenceBMButto
- Page 39 and 40: Button Manager API ReferenceBMGetBu
- Page 41 and 42: Button Manager API ReferenceBMSetIn
- Page 43 and 44: Button Manager API ReferenceBMSetIn
- Page 45 and 46: Button Manager API ReferenceBMSetIn
- Page 47 and 48: Button Manager API ReferenceBMGetIn
- Page 49 and 50: Button Manager API ReferenceBMGetIn
- Page 51 and 52: AHTML Variables for PayPalPayments
- Page 53 and 54: HTML Variables for PayPal Payments
- Page 55 and 56: HTML Variables for PayPal Payments
- Page 57 and 58: HTML Variables for PayPal Payments
- Page 59 and 60: HTML Variables for PayPal Payments
- Page 61 and 62: HTML Variables for PayPal Payments
- Page 63 and 64: HTML Variables for PayPal Payments
- Page 65 and 66: HTML Variables for PayPal Payments
- Page 67 and 68: HTML Variables for PayPal Payments
- Page 69 and 70: HTML Variables for PayPal Payments
- Page 71 and 72: HTML Variables for PayPal Payments
- Page 73 and 74: HTML Variables for PayPal Payments
<strong>Button</strong> <strong>Manager</strong> <strong>API</strong> ReferenceBMGet<strong>Button</strong>Details <strong>API</strong> Operation3BM<strong>Button</strong>Search ErrorsErrorCode Short Message Long Message Correcting This Error...10001 Internal Error Internal Error11994 Search Warning You have exceeded the maximum numberof buttons that can be returned. Pleaseadjust your seach 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.BMGet<strong>Button</strong>Details <strong>API</strong> OperationUse the BMGet<strong>Button</strong>Details <strong>API</strong> operation to obtain information about a hosted <strong>PayPal</strong>Payments Standard button. You can use this information to set the fields that have not changedwhen updating a button.• BMGet<strong>Button</strong>Details Request• BMGet<strong>Button</strong>Details Response• BMUpdate<strong>Button</strong> ErrorsBMGet<strong>Button</strong>Details RequestThe request includes only the ID of the hosted button whose details you want to obtain.BMGet<strong>Button</strong>Details Request FieldsFieldMETHODHOSTEDBUTTONIDDescription(Required) BMGet<strong>Button</strong>Details(Required) The ID of the hosted button whose details you want to obtain.<strong>Button</strong> <strong>Manager</strong> <strong>NVP</strong> <strong>API</strong> April 2012 37