Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 2.88 KB

checkout-options.md

File metadata and controls

45 lines (37 loc) · 2.88 KB

Checkout Options

Structure

CheckoutOptions

Fields

Name Type Tags Description Getter
AllowTipping Boolean Optional Indicates whether the payment allows tipping. Boolean getAllowTipping()
CustomFields List<CustomField> Optional The custom fields requesting information from the buyer. List getCustomFields()
SubscriptionPlanId String Optional The ID of the subscription plan for the buyer to pay and subscribe.
For more information, see Subscription Plan Checkout.
Constraints: Maximum Length: 255		 String getSubscriptionPlanId()
RedirectUrl String Optional The confirmation page URL to redirect the buyer to after Square processes the payment.
Constraints: Maximum Length: 2048		 String getRedirectUrl()
MerchantSupportEmail String Optional The email address that buyers can use to contact the seller.
Constraints: Maximum Length: 256		 String getMerchantSupportEmail()
AskForShippingAddress Boolean Optional Indicates whether to include the address fields in the payment form. Boolean getAskForShippingAddress()
AcceptedPaymentMethods AcceptedPaymentMethods Optional - AcceptedPaymentMethods getAcceptedPaymentMethods()
AppFeeMoney Money Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.		 Money getAppFeeMoney()
ShippingFee ShippingFee Optional - ShippingFee getShippingFee()
EnableCoupon Boolean Optional Indicates whether to include the Add coupon section for the buyer to provide a Square marketing coupon in the payment form. Boolean getEnableCoupon()
EnableLoyalty Boolean Optional Indicates whether to include the REWARDS section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both. Boolean getEnableLoyalty()

Example (as JSON)

{
  "allow_tipping": false,
  "custom_fields": [
    {
      "title": "title8"
    },
    {
      "title": "title8"
    },
    {
      "title": "title8"
    }
  ],
  "subscription_plan_id": "subscription_plan_id0",
  "redirect_url": "redirect_url4",
  "merchant_support_email": "merchant_support_email0"
}