protected void Submit_Click(object sender, EventArgs e)
{
// Create request object
SetCustomerBillingAgreementRequestType request = new SetCustomerBillingAgreementRequestType();
SetCustomerBillingAgreementRequestDetailsType requestDetails = new SetCustomerBillingAgreementRequestDetailsType();
requestDetails.BuyerEmail = buyerEmail.Value;
requestDetails.ReturnURL = returnUrl.Value;
requestDetails.CancelURL = cancelUrl.Value;
BillingAgreementDetailsType baDetails = new BillingAgreementDetailsType();
baDetails.BillingAgreementDescription = billingAgreementText.Value;
baDetails.BillingType = (BillingCodeType)
Enum.Parse( typeof(BillingCodeType), billingType.SelectedValue);
requestDetails.BillingAgreementDetails = baDetails;
request.SetCustomerBillingAgreementRequestDetails = requestDetails;
// Invoke the API
SetCustomerBillingAgreementReq wrapper = new SetCustomerBillingAgreementReq();
wrapper.SetCustomerBillingAgreementRequest = request;
PayPalAPIInterfaceServiceService service = new PayPalAPIInterfaceServiceService();
SetCustomerBillingAgreementResponseType setCustomerBillingAgreementResponse =
service.SetCustomerBillingAgreement(wrapper);
// Check for API return status
setKeyResponseObjects(service, setCustomerBillingAgreementResponse);
}
protected void Submit_Click(object sender, EventArgs e)
{
// Create request object
SetCustomerBillingAgreementRequestType request = new SetCustomerBillingAgreementRequestType();
SetCustomerBillingAgreementRequestDetailsType requestDetails = new SetCustomerBillingAgreementRequestDetailsType();
// (Optional) Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page.
requestDetails.BuyerEmail = buyerEmail.Value;
// (Required) URL to which the buyer's browser is returned after choosing to pay with PayPal.
// Note: PayPal recommends that the value be the final review page on which the buyer confirms the billing agreement.
requestDetails.ReturnURL = returnUrl.Value;
// (Required) URL to which the customer is returned if he does not approve the use of PayPal to pay you.
// Note: PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement.
requestDetails.CancelURL = cancelUrl.Value;
// (Required) Details of the billing agreement such as the billing type, billing agreement description, and payment type.
BillingAgreementDetailsType baDetails = new BillingAgreementDetailsType();
// Description of goods or services associated with the billing agreement. This field is required for each recurring payment billing agreement. PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions. For example, buyer is billed at "9.99 per month for 2 years."
baDetails.BillingAgreementDescription = billingAgreementText.Value;
// (Required) Type of billing agreement. For recurring payments, this field must be set to RecurringPayments. In this case, you can specify up to ten billing agreements. Other defined values are not valid.
// Type of billing agreement for reference transactions. You must have permission from PayPal to use this field. This field must be set to one of the following values:
// * MerchantInitiatedBilling- PayPal creates a billing agreement for each transaction associated with buyer. You must specify version 54.0 or higher to use this option.
// * MerchantInitiatedBillingSingleAgreement- PayPal creates a single billing agreement for all transactions associated with buyer. Use this value unless you need per-transaction billing agreements. You must specify version 58.0 or higher to use this option.
baDetails.BillingType = (BillingCodeType)
Enum.Parse( typeof(BillingCodeType), billingType.SelectedValue);
requestDetails.BillingAgreementDetails = baDetails;
request.SetCustomerBillingAgreementRequestDetails = requestDetails;
// Invoke the API
SetCustomerBillingAgreementReq wrapper = new SetCustomerBillingAgreementReq();
wrapper.SetCustomerBillingAgreementRequest = request;
// Configuration map containing signature credentials and other required configuration.
// For a full list of configuration parameters refer in wiki page
// [https://github.com/paypal/sdk-core-dotnet/wiki/SDK-Configuration-Parameters]
Dictionary<string, string> configurationMap = Configuration.GetAcctAndConfig();
// Create the PayPalAPIInterfaceServiceService service object to make the API call
PayPalAPIInterfaceServiceService service = new PayPalAPIInterfaceServiceService(configurationMap);
// # API call
// Invoke the SetCustomerBillingAgreement method in service wrapper object
SetCustomerBillingAgreementResponseType setCustomerBillingAgreementResponse =
service.SetCustomerBillingAgreement(wrapper);
// Check for API return status
setKeyResponseObjects(service, setCustomerBillingAgreementResponse);
}
/// <summary>
/// Constructor with arguments
/// </summary>
public SetCustomerBillingAgreementRequestDetailsType(BillingAgreementDetailsType billingAgreementDetails, string returnURL, string cancelURL)
{
this.BillingAgreementDetails = billingAgreementDetails;
this.ReturnURL = returnURL;
this.CancelURL = cancelURL;
}
private void populateRequestObject(SetExpressCheckoutRequestType request)
{
SetExpressCheckoutRequestDetailsType ecDetails = new SetExpressCheckoutRequestDetailsType();
if(returnUrl.Value != "")
{
ecDetails.ReturnURL = returnUrl.Value;
}
if(cancelUrl.Value != "")
{
ecDetails.CancelURL = cancelUrl.Value;
}
if (buyerEmail.Value != "")
{
ecDetails.BuyerEmail = buyerEmail.Value;
}
//Fix for release
//NOTE: Setting this field overrides the setting you specified in your Merchant Account Profile
if (reqConfirmShipping.SelectedIndex != 0)
{
ecDetails.ReqConfirmShipping = reqConfirmShipping.SelectedValue;
}
if (addressoverride.SelectedIndex != 0)
{
ecDetails.AddressOverride = addressoverride.SelectedValue;
}
if (noShipping.SelectedIndex != 0)
{
ecDetails.NoShipping = noShipping.SelectedValue;
}
if (solutionType.SelectedIndex != 0)
{
ecDetails.SolutionType = (SolutionTypeType)
Enum.Parse(typeof(SolutionTypeType), solutionType.SelectedValue);
}
/* Populate payment requestDetails.
* SetExpressCheckout allows parallel payments of upto 10 payments.
* This samples shows just one payment.
*/
PaymentDetailsType paymentDetails = new PaymentDetailsType();
ecDetails.PaymentDetails.Add(paymentDetails);
double orderTotal = 0.0;
double itemTotal = 0.0;
CurrencyCodeType currency = (CurrencyCodeType)
Enum.Parse(typeof(CurrencyCodeType), currencyCode.SelectedValue);
if (shippingTotal.Value != "")
{
paymentDetails.ShippingTotal = new BasicAmountType(currency, shippingTotal.Value);
orderTotal += Double.Parse(shippingTotal.Value);
}
if (insuranceTotal.Value != "" && !double.Parse(insuranceTotal.Value).Equals(0.0))
{
paymentDetails.InsuranceTotal = new BasicAmountType(currency, insuranceTotal.Value);
paymentDetails.InsuranceOptionOffered = "true";
orderTotal += Double.Parse(insuranceTotal.Value);
}
if (handlingTotal.Value != "")
{
paymentDetails.HandlingTotal = new BasicAmountType(currency, handlingTotal.Value);
orderTotal += Double.Parse(handlingTotal.Value);
}
if (taxTotal.Value != "")
{
paymentDetails.TaxTotal = new BasicAmountType(currency, taxTotal.Value);
orderTotal += Double.Parse(taxTotal.Value);
}
if (orderDescription.Value != "")
{
paymentDetails.OrderDescription = orderDescription.Value;
}
paymentDetails.PaymentAction = (PaymentActionCodeType)
Enum.Parse(typeof(PaymentActionCodeType), paymentAction.SelectedValue);
if (shippingName.Value != "" && shippingStreet1.Value != ""
&& shippingCity.Value != "" && shippingState.Value != ""
&& shippingCountry.Value != "" && shippingPostalCode.Value != "")
{
AddressType shipAddress = new AddressType();
shipAddress.Name = shippingName.Value;
shipAddress.Street1 = shippingStreet1.Value;
shipAddress.Street2 = shippingStreet2.Value;
shipAddress.CityName = shippingCity.Value;
shipAddress.StateOrProvince = shippingState.Value;
shipAddress.Country = (CountryCodeType)
Enum.Parse(typeof(CountryCodeType), shippingCountry.Value);
shipAddress.PostalCode = shippingPostalCode.Value;
//Fix for release
shipAddress.Phone = shippingPhone.Value;
ecDetails.PaymentDetails[0].ShipToAddress = shipAddress;
}
// Each payment can include requestDetails about multiple items
// This example shows just one payment item
if (itemName.Value != null && itemAmount.Value != null && itemQuantity.Value != null)
{
PaymentDetailsItemType itemDetails = new PaymentDetailsItemType();
itemDetails.Name = itemName.Value;
itemDetails.Amount = new BasicAmountType(currency, itemAmount.Value);
itemDetails.Quantity = Int32.Parse(itemQuantity.Value);
itemDetails.ItemCategory = (ItemCategoryType)
Enum.Parse(typeof(ItemCategoryType), itemCategory.SelectedValue);
itemTotal += Double.Parse(itemDetails.Amount.value) * itemDetails.Quantity.Value;
if (salesTax.Value != "")
{
itemDetails.Tax = new BasicAmountType(currency, salesTax.Value);
orderTotal += Double.Parse(salesTax.Value);
}
if (itemDescription.Value != "")
{
itemDetails.Description = itemDescription.Value;
}
paymentDetails.PaymentDetailsItem.Add(itemDetails);
}
orderTotal += itemTotal;
paymentDetails.ItemTotal = new BasicAmountType(currency, itemTotal.ToString());
paymentDetails.OrderTotal = new BasicAmountType(currency, orderTotal.ToString());
// Set Billing agreement (for Reference transactions & Recurring payments)
if (billingAgreementText.Value != "")
{
BillingCodeType billingCodeType = (BillingCodeType)
Enum.Parse(typeof(BillingCodeType), billingType.SelectedValue);
BillingAgreementDetailsType baType = new BillingAgreementDetailsType(billingCodeType);
baType.BillingAgreementDescription = billingAgreementText.Value;
ecDetails.BillingAgreementDetails.Add(baType);
}
//Fix for release
if (localeCode.SelectedIndex != 0)
{
ecDetails.LocaleCode = localeCode.SelectedValue;
}
// Set styling attributes for PayPal page
if (pageStyle.Value != "")
{
ecDetails.PageStyle = pageStyle.Value;
}
if (cppheaderimage.Value != "")
{
ecDetails.cppHeaderImage = cppheaderimage.Value;
}
if (cppheaderbordercolor.Value != "")
{
ecDetails.cppHeaderBorderColor = cppheaderbordercolor.Value;
}
if (cppheaderbackcolor.Value != "")
{
ecDetails.cppHeaderBackColor = cppheaderbackcolor.Value;
}
if (cpppayflowcolor.Value != "")
{
ecDetails.cppPayflowColor = cpppayflowcolor.Value;
}
if (brandName.Value != "")
{
ecDetails.BrandName = brandName.Value;
}
request.SetExpressCheckoutRequestDetails = ecDetails;
}
private void populateRequestObject(SetExpressCheckoutRequestType request)
{
SetExpressCheckoutRequestDetailsType ecDetails = new SetExpressCheckoutRequestDetailsType();
if(returnUrl.Value != string.Empty)
{
ecDetails.ReturnURL = returnUrl.Value;
}
if(cancelUrl.Value != string.Empty)
{
ecDetails.CancelURL = cancelUrl.Value;
}
// (Optional) Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion on the PayPal pages.
if (buyerEmail.Value != string.Empty)
{
ecDetails.BuyerEmail = buyerEmail.Value;
}
// Fix for release
// NOTE: Setting this field overrides the setting you specified in your Merchant Account Profile
// Indicates whether or not you require the buyer's shipping address on
// file with PayPal be a confirmed address. For digital goods,
// this field is required, and you must set it to 0. It is one of the following values:
// 0 – You do not require the buyer's shipping address be a confirmed address.
// 1 – You require the buyer's shipping address be a confirmed address.
// Note:
// Setting this field overrides the setting you specified in your Merchant Account Profile.
// Character length and limitations: 1 single-byte numeric character
if (reqConfirmShipping.SelectedIndex != 0)
{
ecDetails.ReqConfirmShipping = reqConfirmShipping.SelectedValue;
}
// (Optional) Determines whether or not the PayPal pages should
//display the shipping address set by you in this SetExpressCheckout request,
// not the shipping address on file with PayPal for this buyer. Displaying
// the PayPal street address on file does not allow the buyer to edit that address.
// It is one of the following values:
// 0 – The PayPal pages should not display the shipping address.
// 1 – The PayPal pages should display the shipping address.
// Character length and limitations: 1 single-byte numeric character
if (addressoverride.SelectedIndex != 0)
{
ecDetails.AddressOverride = addressoverride.SelectedValue;
}
if (noShipping.SelectedIndex != 0)
{
ecDetails.NoShipping = noShipping.SelectedValue;
}
if (solutionType.SelectedIndex != 0)
{
ecDetails.SolutionType = (SolutionTypeType)
Enum.Parse(typeof(SolutionTypeType), solutionType.SelectedValue);
}
/* Populate payment requestDetails.
* SetExpressCheckout allows parallel payments of upto 10 payments.
* This samples shows just one payment.
*/
PaymentDetailsType paymentDetails = new PaymentDetailsType();
ecDetails.PaymentDetails.Add(paymentDetails);
// (Required) Total cost of the transaction to the buyer. If shipping cost and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. Set this field to 0 if the transaction does not include a one-time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged. When the field is set to 0, purchase-specific fields are ignored.
double orderTotal = 0.0;
// Sum of cost of all items in this order. For digital goods, this field is required.
double itemTotal = 0.0;
CurrencyCodeType currency = (CurrencyCodeType)
Enum.Parse(typeof(CurrencyCodeType), currencyCode.SelectedValue);
// (Optional) Total shipping costs for this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations:
// Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol.
// It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,)
if (shippingTotal.Value != string.Empty)
{
paymentDetails.ShippingTotal = new BasicAmountType(currency, shippingTotal.Value);
orderTotal += Convert.ToDouble(shippingTotal.Value);
}
//(Optional) Total shipping insurance costs for this order.
// The value must be a non-negative currency amount or null if you offer insurance options.
// Note:
// You must set the currencyID attribute to one of the 3-character currency
// codes for any of the supported PayPal currencies.
// Character length and limitations:
// Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places,
// the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
// InsuranceTotal is available since version 53.0.
if (insuranceTotal.Value != string.Empty && !Convert.ToDouble(insuranceTotal.Value).Equals(0.0))
{
paymentDetails.InsuranceTotal = new BasicAmountType(currency, insuranceTotal.Value);
paymentDetails.InsuranceOptionOffered = "true";
orderTotal += Convert.ToDouble(insuranceTotal.Value);
}
//(Optional) Total handling costs for this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which
// cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places,
// the decimal separator must be a period (.), and the optional
// thousands separator must be a comma (,).
if (handlingTotal.Value != string.Empty)
{
paymentDetails.HandlingTotal = new BasicAmountType(currency, handlingTotal.Value);
orderTotal += Convert.ToDouble(handlingTotal.Value);
}
//(Optional) Sum of tax for all items in this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which
// cannot exceed $10,000 USD in any currency. It includes no currency symbol.
// It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
if (taxTotal.Value != string.Empty)
{
paymentDetails.TaxTotal = new BasicAmountType(currency, taxTotal.Value);
orderTotal += Convert.ToDouble(taxTotal.Value);
}
//(Optional) Description of items the buyer is purchasing.
// Note:
// The value you specify is available only if the transaction includes a purchase.
// This field is ignored if you set up a billing agreement for a recurring payment
// that is not immediately charged.
// Character length and limitations: 127 single-byte alphanumeric characters
if (orderDescription.Value != string.Empty)
{
paymentDetails.OrderDescription = orderDescription.Value;
}
// How you want to obtain payment. When implementing parallel payments,
// this field is required and must be set to Order.
// When implementing digital goods, this field is required and must be set to Sale.
// If the transaction does not include a one-time purchase, this field is ignored.
// It is one of the following values:
// Sale – This is a final sale for which you are requesting payment (default).
// Authorization – This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
// Order – This payment is an order authorization subject to settlement with PayPal Authorization and Capture.
paymentDetails.PaymentAction = (PaymentActionCodeType)
Enum.Parse(typeof(PaymentActionCodeType), paymentAction.SelectedValue);
if (shippingName.Value != string.Empty && shippingStreet1.Value != string.Empty
&& shippingCity.Value != string.Empty && shippingState.Value != string.Empty
&& shippingCountry.Value != string.Empty && shippingPostalCode.Value != string.Empty)
{
AddressType shipAddress = new AddressType();
// Person's name associated with this shipping address.
// It is required if using a shipping address.
// Character length and limitations: 32 single-byte characters
shipAddress.Name = shippingName.Value;
//First street address. It is required if using a shipping address.
//Character length and limitations: 100 single-byte characters
shipAddress.Street1 = shippingStreet1.Value;
//(Optional) Second street address.
//Character length and limitations: 100 single-byte characters
shipAddress.Street2 = shippingStreet2.Value;
//Name of city. It is required if using a shipping address.
//Character length and limitations: 40 single-byte characters
shipAddress.CityName = shippingCity.Value;
// State or province. It is required if using a shipping address.
// Character length and limitations: 40 single-byte characters
shipAddress.StateOrProvince = shippingState.Value;
// Country code. It is required if using a shipping address.
// Character length and limitations: 2 single-byte characters
shipAddress.Country = (CountryCodeType)
Enum.Parse(typeof(CountryCodeType), shippingCountry.Value);
// U.S. ZIP code or other country-specific postal code.
// It is required if using a U.S. shipping address and may be
// required for other countries.
// Character length and limitations: 20 single-byte characters
shipAddress.PostalCode = shippingPostalCode.Value;
//Fix for release
shipAddress.Phone = shippingPhone.Value;
ecDetails.PaymentDetails[0].ShipToAddress = shipAddress;
}
// Each payment can include requestDetails about multiple items
// This example shows just one payment item
if (itemName.Value != null && itemAmount.Value != null && itemQuantity.Value != null)
{
PaymentDetailsItemType itemDetails = new PaymentDetailsItemType();
itemDetails.Name = itemName.Value;
itemDetails.Amount = new BasicAmountType(currency, itemAmount.Value);
itemDetails.Quantity = Convert.ToInt32(itemQuantity.Value);
// Indicates whether an item is digital or physical. For digital goods, this field is required and must be set to Digital. It is one of the following values:
// 1.Digital
// 2.Physical
// This field is available since version 65.1.
itemDetails.ItemCategory = (ItemCategoryType)
Enum.Parse(typeof(ItemCategoryType), itemCategory.SelectedValue);
itemTotal += Convert.ToDouble(itemDetails.Amount.value) * itemDetails.Quantity.Value;
//(Optional) Item sales tax.
// Note: You must set the currencyID attribute to one of
// the 3-character currency codes for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
if (salesTax.Value != string.Empty)
{
itemDetails.Tax = new BasicAmountType(currency, salesTax.Value);
orderTotal += Convert.ToDouble(salesTax.Value);
}
//(Optional) Item description.
// Character length and limitations: 127 single-byte characters
// This field is introduced in version 53.0.
if (itemDescription.Value != string.Empty)
{
itemDetails.Description = itemDescription.Value;
}
paymentDetails.PaymentDetailsItem.Add(itemDetails);
}
orderTotal += itemTotal;
paymentDetails.ItemTotal = new BasicAmountType(currency, itemTotal.ToString());
paymentDetails.OrderTotal = new BasicAmountType(currency, orderTotal.ToString());
//(Optional) Your URL for receiving Instant Payment Notification (IPN)
//about this transaction. If you do not specify this value in the request,
//the notification URL from your Merchant Profile is used, if one exists.
//Important:
//The notify URL applies only to DoExpressCheckoutPayment.
//This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
//Character length and limitations: 2,048 single-byte alphanumeric characters
paymentDetails.NotifyURL = ipnNotificationUrl.Value.Trim();
// Set Billing agreement (for Reference transactions & Recurring payments)
if (billingAgreementText.Value != string.Empty)
{
//(Required) Type of billing agreement. For recurring payments,
//this field must be set to RecurringPayments.
//In this case, you can specify up to ten billing agreements.
//Other defined values are not valid.
//Type of billing agreement for reference transactions.
//You must have permission from PayPal to use this field.
//This field must be set to one of the following values:
// 1. MerchantInitiatedBilling - PayPal creates a billing agreement
// for each transaction associated with buyer.You must specify
// version 54.0 or higher to use this option.
// 2. MerchantInitiatedBillingSingleAgreement - PayPal creates a
// single billing agreement for all transactions associated with buyer.
// Use this value unless you need per-transaction billing agreements.
// You must specify version 58.0 or higher to use this option.
BillingCodeType billingCodeType = (BillingCodeType)
Enum.Parse(typeof(BillingCodeType), billingType.SelectedValue);
BillingAgreementDetailsType baType = new BillingAgreementDetailsType(billingCodeType);
baType.BillingAgreementDescription = billingAgreementText.Value;
ecDetails.BillingAgreementDetails.Add(baType);
}
//(Optional) Locale of pages displayed by PayPal during Express Checkout.
if (localeCode.SelectedIndex != 0)
{
ecDetails.LocaleCode = localeCode.SelectedValue;
}
// (Optional) Name of the Custom Payment Page Style for payment pages associated with this button or link. It corresponds to the HTML variable page_style for customizing payment pages. It is the same name as the Page Style Name you chose to add or edit the page style in your PayPal Account profile.
if (pageStyle.Value != string.Empty)
{
ecDetails.PageStyle = pageStyle.Value;
}
// (Optional) URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server. If you do not specify an image, the business name displays.
if (cppheaderimage.Value != string.Empty)
{
ecDetails.cppHeaderImage = cppheaderimage.Value;
}
// (Optional) Sets the border color around the header of the payment page. The border is a 2-pixel perimeter around the header space, which is 750 pixels wide by 90 pixels high. By default, the color is black.
if (cppheaderbordercolor.Value != string.Empty)
{
ecDetails.cppHeaderBorderColor = cppheaderbordercolor.Value;
}
// (Optional) Sets the background color for the header of the payment page. By default, the color is white.
if (cppheaderbackcolor.Value != string.Empty)
{
ecDetails.cppHeaderBackColor = cppheaderbackcolor.Value;
}
// (Optional) Sets the background color for the payment page. By default, the color is white.
if (cpppayflowcolor.Value != string.Empty)
{
ecDetails.cppPayflowColor = cpppayflowcolor.Value;
}
// (Optional) A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages.
if (brandName.Value != string.Empty)
{
ecDetails.BrandName = brandName.Value;
}
request.SetExpressCheckoutRequestDetails = ecDetails;
}
/**
* Constructor with arguments
*/
public SetCustomerBillingAgreementRequestDetailsType(BillingAgreementDetailsType BillingAgreementDetails, string ReturnURL, string CancelURL)
{
this.BillingAgreementDetails = BillingAgreementDetails;
this.ReturnURL = ReturnURL;
this.CancelURL = CancelURL;
}
private void PopulateSetExpressCheckoutRequestObject(SetExpressCheckoutRequestType request, User user, Product product, string referrer, int quantity, string billingAgreementText = "")
{
const string zero = "0.00";
var orderTotal = 0.0;
var itemTotal = 0.0;
// Each payment can include requestDetails about multiple items
// This example shows just one payment item
if (quantity < 1) throw new Exception("Insufficient quantity");
var itemDetails = new PaymentDetailsItemType {
Name = product.Name,
Amount = new BasicAmountType(MSKatushaCurrencyCode, product.Amount),
Quantity = quantity,
//ItemCategory = ItemCategoryType.PHYSICAL,
Tax = new BasicAmountType(MSKatushaCurrencyCode, product.Tax),
Description = product.Description,
};
itemTotal += (Double.Parse(itemDetails.Amount.value) * quantity);
orderTotal += Double.Parse(itemDetails.Tax.value);
orderTotal += itemTotal;
var paymentDetails = new PaymentDetailsType {
ShippingTotal = new BasicAmountType(MSKatushaCurrencyCode, zero),
OrderDescription = MSKatushaorderDescription,
PaymentAction = PaymentActionCodeType.SALE,
ItemTotal = new BasicAmountType(MSKatushaCurrencyCode, itemTotal.ToString(CultureInfo.InvariantCulture)),
Custom = product.FriendlyName + "|" +(referrer ?? ""),
};
orderTotal += Double.Parse(paymentDetails.ShippingTotal.value);
paymentDetails.OrderTotal = new BasicAmountType(MSKatushaCurrencyCode, orderTotal.ToString(CultureInfo.InvariantCulture));
paymentDetails.PaymentDetailsItem.Add(itemDetails);
var ecDetails = new SetExpressCheckoutRequestDetailsType {
ReturnURL = _settings.ReturnUrl,
CancelURL = _settings.CancelUrl,
BuyerEmail = user.Email,
AddressOverride = "0",
NoShipping = "1",
SolutionType = SolutionTypeType.SOLE,
BuyerDetails = new BuyerDetailsType {BuyerId = user.Guid.ToString(), BuyerRegistrationDate = user.CreationDate.ToString("s"), BuyerUserName = user.UserName},
cppHeaderImage = MSKatushaImageUrl,
BrandName = MSKatushaBrandName
//PageStyle = pageStyle.Value,
//cppHeaderBorderColor = cppheaderbordercolor.Value,
//cppHeaderBackColor = cppheaderbackcolor.Value,
//cppPayflowColor = cpppayflowcolor.Value,
};
ecDetails.PaymentDetails.Add(paymentDetails);
if (!String.IsNullOrWhiteSpace(billingAgreementText)) {
var baType = new BillingAgreementDetailsType(BillingCodeType.MERCHANTINITIATEDBILLINGSINGLEAGREEMENT) { BillingAgreementDescription = billingAgreementText };
ecDetails.BillingAgreementDetails.Add(baType);
}
request.SetExpressCheckoutRequestDetails = ecDetails;
/*
//if (insuranceTotal.Value != "" && !double.Parse(insuranceTotal.Value).Equals(0.0)) {
// paymentDetails.InsuranceTotal = new BasicAmountType(MSKatushaCurrencyCode, zero);
// paymentDetails.InsuranceOptionOffered = "true";
// orderTotal += Double.Parse(insuranceTotal.Value);
//}
//if (handlingTotal.Value != "") {
// paymentDetails.HandlingTotal = new BasicAmountType(MSKatushaCurrencyCode, handlingTotal.Value);
// orderTotal += Double.Parse(handlingTotal.Value);
//}
//if (taxTotal.Value != "") {
// paymentDetails.TaxTotal = new BasicAmountType(MSKatushaCurrencyCode, taxTotal.Value);
// orderTotal += Double.Parse(taxTotal.Value);
//}
//if (shippingName.Value != "" && shippingStreet1.Value != ""
// && shippingCity.Value != "" && shippingState.Value != ""
// && shippingCountry.Value != "" && shippingPostalCode.Value != "") {
// AddressType shipAddress = new AddressType();
// shipAddress.Name = shippingName.Value;
// shipAddress.Street1 = shippingStreet1.Value;
// shipAddress.Street2 = shippingStreet2.Value;
// shipAddress.CityName = shippingCity.Value;
// shipAddress.StateOrProvince = shippingState.Value;
// shipAddress.Country = (CountryCodeType)
// Enum.Parse(typeof(CountryCodeType), shippingCountry.Value);
// shipAddress.PostalCode = shippingPostalCode.Value;
// ecDetails.PaymentDetails[0].ShipToAddress = shipAddress;
//}
* */
}
/// <summary>
/// Handles Set Express Checkout For Recurring Payments
/// </summary>
/// <param name="contextHttp"></param>
private void SetExpressCheckoutForRecurringPayments(HttpContext contextHttp)
{
NameValueCollection parameters = contextHttp.Request.Params;
// Configuration map containing signature credentials and other required configuration.
// For a full list of configuration parameters refer in wiki page
// [https://github.com/paypal/sdk-core-dotnet/wiki/SDK-Configuration-Parameters]
Dictionary<string, string> configurationMap = Configuration.GetAcctAndConfig();
// Create the PayPalAPIInterfaceServiceService service object to make the API call
PayPalAPIInterfaceServiceService service = new PayPalAPIInterfaceServiceService(configurationMap);
SetExpressCheckoutRequestType setExpressCheckoutReq = new SetExpressCheckoutRequestType();
SetExpressCheckoutRequestDetailsType details = new SetExpressCheckoutRequestDetailsType();
string requestUrl = ConfigurationManager.AppSettings["HOSTING_ENDPOINT"].ToString();
// (Required) URL to which the buyer's browser is returned after choosing to pay with PayPal. For digital goods, you must add JavaScript to this page to close the in-context experience.
// Note:
// PayPal recommends that the value be the final review page on which the buyer confirms the order and payment or billing agreement.
UriBuilder uriBuilder = new UriBuilder(requestUrl);
uriBuilder.Path = contextHttp.Request.ApplicationPath
+ (contextHttp.Request.ApplicationPath.EndsWith("/") ? string.Empty : "/")
+ "UseCaseSamples/SetExpressCheckoutForRecurringPayments.aspx";
string returnUrl = uriBuilder.Uri.ToString();
// (Required) URL to which the buyer is returned if the buyer does not approve the use of PayPal to pay you. For digital goods, you must add JavaScript to this page to close the in-context experience.
// Note:
// PayPal recommends that the value be the original page on which the buyer chose to pay with PayPal or establish a billing agreement.
uriBuilder = new UriBuilder(requestUrl);
uriBuilder.Path = contextHttp.Request.ApplicationPath
+ (contextHttp.Request.ApplicationPath.EndsWith("/") ? string.Empty : "/")
+ "UseCaseSamples/SetExpressCheckoutForRecurringPayments.aspx";
string cancelUrl = uriBuilder.Uri.ToString();
// (Required) URL to which the buyer's browser is returned after choosing
// to pay with PayPal. For digital goods, you must add JavaScript to this
// page to close the in-context experience.
// Note:
// PayPal recommends that the value be the final review page on which the buyer
// confirms the order and payment or billing agreement.
// Character length and limitations: 2048 single-byte characters
details.ReturnURL = returnUrl + "?currencyCodeType=" + parameters["currencyCode"];
details.CancelURL = cancelUrl;
// (Optional) Email address of the buyer as entered during checkout.
// PayPal uses this value to pre-fill the PayPal membership sign-up portion on the PayPal pages.
// Character length and limitations: 127 single-byte alphanumeric characters
details.BuyerEmail = parameters["buyerMail"];
decimal itemTotal = 0.0M;
decimal orderTotal = 0.0M;
// Cost of item. This field is required when you pass a value for ItemCategory.
string amountItems = parameters["itemAmount"];
// Item quantity. This field is required when you pass a value for ItemCategory.
// For digital goods (ItemCategory=Digital), this field is required.
// Character length and limitations: Any positive integer
string qtyItems = parameters["itemQuantity"];
// Item name. This field is required when you pass a value for ItemCategory.
// Character length and limitations: 127 single-byte characters
string names = parameters["itemName"];
List<PaymentDetailsItemType> lineItems = new List<PaymentDetailsItemType>();
PaymentDetailsItemType item = new PaymentDetailsItemType();
BasicAmountType amt = new BasicAmountType();
// PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables.
amt.currencyID = (CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]);
amt.value = amountItems;
item.Quantity = Convert.ToInt32(qtyItems);
item.Name = names;
item.Amount = amt;
// Indicates whether an item is digital or physical. For digital goods, this field is required and must be set to Digital. It is one of the following values:
// 1. Digital
// 2. Physical
item.ItemCategory = (ItemCategoryType)Enum.Parse(typeof(ItemCategoryType), parameters["itemCategory"]);
// (Optional) Item sales tax.
// Note: You must set the currencyID attribute to one of
// the 3-character currency codes for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
if (parameters["salesTax"] != string.Empty)
{
item.Tax = new BasicAmountType((CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]), parameters["salesTax"]);
}
itemTotal += Convert.ToDecimal(qtyItems) * Convert.ToDecimal(amountItems);
orderTotal += itemTotal;
List<PaymentDetailsType> payDetails = new List<PaymentDetailsType>();
PaymentDetailsType paydtl = new PaymentDetailsType();
// How you want to obtain payment. When implementing parallel payments,
// this field is required and must be set to Order.
// When implementing digital goods, this field is required and must be set to Sale.
// If the transaction does not include a one-time purchase, this field is ignored.
// It is one of the following values:
// Sale – This is a final sale for which you are requesting payment (default).
// Authorization – This payment is a basic authorization subject to settlement with PayPal Authorization and Capture.
// Order – This payment is an order authorization subject to settlement with PayPal Authorization and Capture.
paydtl.PaymentAction = (PaymentActionCodeType)Enum.Parse(typeof(PaymentActionCodeType), parameters["paymentType"]);
// (Optional) Total shipping costs for this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations:
// Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol.
// It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,)
if (parameters["shippingTotal"] != string.Empty)
{
BasicAmountType shippingTotal = new BasicAmountType();
shippingTotal.value = parameters["shippingTotal"];
shippingTotal.currencyID = (CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]);
orderTotal += Convert.ToDecimal(parameters["shippingTotal"]);
paydtl.ShippingTotal = shippingTotal;
}
// (Optional) Total shipping insurance costs for this order.
// The value must be a non-negative currency amount or null if you offer insurance options.
// Note:
// You must set the currencyID attribute to one of the 3-character currency
// codes for any of the supported PayPal currencies.
// Character length and limitations:
// Value is a positive number which cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places,
// the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
// InsuranceTotal is available since version 53.0.
if (parameters["insuranceTotal"] != string.Empty)
{
paydtl.InsuranceTotal = new BasicAmountType((CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]), parameters["insuranceTotal"]);
paydtl.InsuranceOptionOffered = "true";
orderTotal += Convert.ToDecimal(parameters["insuranceTotal"]);
}
// (Optional) Total handling costs for this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which
// cannot exceed $10,000 USD in any currency.
// It includes no currency symbol. It must have 2 decimal places,
// the decimal separator must be a period (.), and the optional
// thousands separator must be a comma (,).
if (parameters["handlingTotal"] != string.Empty)
{
paydtl.HandlingTotal = new BasicAmountType((CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]), parameters["handlingTotal"]);
orderTotal += Convert.ToDecimal(parameters["handlingTotal"]);
}
// (Optional) Sum of tax for all items in this order.
// Note:
// You must set the currencyID attribute to one of the 3-character currency codes
// for any of the supported PayPal currencies.
// Character length and limitations: Value is a positive number which
// cannot exceed $10,000 USD in any currency. It includes no currency symbol.
// It must have 2 decimal places, the decimal separator must be a period (.),
// and the optional thousands separator must be a comma (,).
if (parameters["taxTotal"] != string.Empty)
{
paydtl.TaxTotal = new BasicAmountType((CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]), parameters["taxTotal"]);
orderTotal += Convert.ToDecimal(parameters["taxTotal"]);
}
// (Optional) Description of items the buyer is purchasing.
// Note:
// The value you specify is available only if the transaction includes a purchase.
// This field is ignored if you set up a billing agreement for a recurring payment
// that is not immediately charged.
// Character length and limitations: 127 single-byte alphanumeric characters
if (parameters["orderDescription"] != string.Empty)
{
paydtl.OrderDescription = parameters["orderDescription"];
}
BasicAmountType itemsTotal = new BasicAmountType();
itemsTotal.value = Convert.ToString(itemTotal);
// PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables.
itemsTotal.currencyID = (CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]);
paydtl.OrderTotal = new BasicAmountType((CurrencyCodeType)Enum.Parse(typeof(CurrencyCodeType), parameters["currencyCode"]), Convert.ToString(orderTotal));
paydtl.PaymentDetailsItem = lineItems;
paydtl.ItemTotal = itemsTotal;
// (Optional) Your URL for receiving Instant Payment Notification (IPN)
// about this transaction. If you do not specify this value in the request,
// the notification URL from your Merchant Profile is used, if one exists.
// Important:
// The notify URL applies only to DoExpressCheckoutPayment.
// This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.
// Character length and limitations: 2,048 single-byte alphanumeric characters
paydtl.NotifyURL = parameters["notifyURL"];
payDetails.Add(paydtl);
details.PaymentDetails = payDetails;
if (parameters["billingAgreementText"] != string.Empty)
{
// (Required) Type of billing agreement. For recurring payments,
// this field must be set to RecurringPayments.
// In this case, you can specify up to ten billing agreements.
// Other defined values are not valid.
// Type of billing agreement for reference transactions.
// You must have permission from PayPal to use this field.
// This field must be set to one of the following values:
// 1. MerchantInitiatedBilling - PayPal creates a billing agreement
// for each transaction associated with buyer.You must specify
// version 54.0 or higher to use this option.
// 2. MerchantInitiatedBillingSingleAgreement - PayPal creates a
// single billing agreement for all transactions associated with buyer.
// Use this value unless you need per-transaction billing agreements.
// You must specify version 58.0 or higher to use this option.
BillingAgreementDetailsType billingAgreement = new BillingAgreementDetailsType((BillingCodeType)Enum.Parse(typeof(BillingCodeType), parameters["billingType"]));
// Description of goods or services associated with the billing agreement.
// This field is required for each recurring payment billing agreement.
// PayPal recommends that the description contain a brief summary of
// the billing agreement terms and conditions. For example,
// buyer is billed at "9.99 per month for 2 years".
// Character length and limitations: 127 single-byte alphanumeric characters
billingAgreement.BillingAgreementDescription = parameters["billingAgreementText"];
List<BillingAgreementDetailsType> billList = new List<BillingAgreementDetailsType>();
billList.Add(billingAgreement);
details.BillingAgreementDetails = billList;
}
setExpressCheckoutReq.SetExpressCheckoutRequestDetails = details;
SetExpressCheckoutReq expressCheckoutReq = new SetExpressCheckoutReq();
expressCheckoutReq.SetExpressCheckoutRequest = setExpressCheckoutReq;
SetExpressCheckoutResponseType response = null;
try
{
response = service.SetExpressCheckout(expressCheckoutReq);
}
catch (System.Exception ex)
{
contextHttp.Response.Write(ex.Message);
return;
}
Dictionary<string, string> responseValues = new Dictionary<string, string>();
string redirectUrl = null;
if (!response.Ack.ToString().Trim().ToUpper().Equals(AckCode.FAILURE.ToString()) && !response.Ack.ToString().Trim().ToUpper().Equals(AckCode.FAILUREWITHWARNING.ToString()))
{
redirectUrl = ConfigurationManager.AppSettings["PAYPAL_REDIRECT_URL"].ToString() + "_express-checkout&token=" + response.Token;
}
responseValues.Add("Acknowledgement", response.Ack.ToString().Trim().ToUpper());
Display(contextHttp, "SetExpressCheckoutForRecurringPayments", "SetExpressCheckout", responseValues, service.getLastRequest(), service.getLastResponse(), response.Errors, redirectUrl);
}
