PayPal Button Manager API (NVP)
PayPal Button Manager API (NVP) PayPal Button Manager API (NVP)
3Button Manager API ReferenceBMGetButtonDetails API OperationBMGetButtonDetails ResponseThe response fields contain all non-inventory information related to the button.BMGetButtonDetails Response FieldsFieldBUTTONTYPEBUTTONCODEBUTTONSUBTYPEHOSTEDBUTTONIDWEBSITECODEEMAILLINKL_BUTTONVARnDescriptionThe 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.0The 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 PayPalThe use of button. It is one of the following values:• PRODUCTS - button is used to purchase products• SERVICES - button is used to purchase servicesID of a PayPal hosted buttonHTML code for web pagesCode for email links and links in other documents that support external linksHTML standard button variablesOption Details FieldsFieldOPTIONnNAMEDescription(Optional) The menu nameIt is one or more variables, in which n is a digit between 0 and 4, inclusive, forhosted buttons; otherwise, it is a digit between 0 and 9, inclusive.38 April 2012 Button Manager NVP API
Button Manager API ReferenceBMGetButtonDetails API Operation3Option Selection Details FieldsFieldL_OPTIONnSELECTxL_OPTION0PRICExOPTIONnTYPEDescription(Optional) The menu item’s nameIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 9, inclusive(Optional) The price associated with the first menu itemIt is a list of variables for each OPTION0NAME, in which x is a digit between 0and 9, inclusiveNOTE: If you specify a price, you cannot set a button variable to amount.(Optional) The installment option type for an OPTIONnNAME, which is one ofthe following values:• FULL - Payment in full• VARIABLE - Variable installments• EMI - Equal installmentsNOTE: Only available for Installment Plan buttons.Installment DetailsFieldL_OPTIONnBILLINGPERIODxL_OPTIONnBILLINGPFREQUENCYxL_OPTIONnTOTALBILLINGCYCLESxL_OPTIONnAMOUNTxDescription(Optional) The installment cycle unit, which is one of the following values:• NoBillingPeriodType - None (default)• Day• Week• SemiMonth• Month• YearIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(Optional) The installment cycle frequency in units, e.g. if the billingfrequency is 2 and the billing period is Month, the billing cycle is every 2months. The default billing frequency is 1.It is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(Optional) The total number of billing cycles, regardless of the duration of acycle; 1 is the defaultIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(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 0and 4, inclusiveButton Manager NVP API April 2012 39
- 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 and 36: Button Manager API ReferenceBMButto
- Page 37: 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> Operation3Option Selection Details FieldsFieldL_OPTIONnSELECTxL_OPTION0PRICExOPTIONnTYPEDescription(Optional) The menu item’s nameIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 9, inclusive(Optional) The price associated with the first menu itemIt is a list of variables for each OPTION0NAME, in which x is a digit between 0and 9, inclusiveNOTE: If you specify a price, you cannot set a button variable to amount.(Optional) The installment option type for an OPTIONnNAME, which is one ofthe following values:• FULL - Payment in full• VARIABLE - Variable installments• EMI - Equal installmentsNOTE: Only available for Installment Plan buttons.Installment DetailsFieldL_OPTIONnBILLINGPERIODxL_OPTIONnBILLINGPFREQUENCYxL_OPTIONnTOTALBILLINGCYCLESxL_OPTIONnAMOUNTxDescription(Optional) The installment cycle unit, which is one of the following values:• NoBillingPeriodType - None (default)• Day• Week• SemiMonth• Month• YearIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(Optional) The installment cycle frequency in units, e.g. if the billingfrequency is 2 and the billing period is Month, the billing cycle is every 2months. The default billing frequency is 1.It is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(Optional) The total number of billing cycles, regardless of the duration of acycle; 1 is the defaultIt is a list of variables for each OPTIONnNAME, in which x is a digit between 0and 4, inclusive(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 0and 4, inclusive<strong>Button</strong> <strong>Manager</strong> <strong>NVP</strong> <strong>API</strong> April 2012 39
Change language