BTVenmoRequest

@objcMembers
public class BTVenmoRequest : NSObject

A BTVenmoRequest specifies options that contribute to the Venmo flow

Show on GitHub

Public Properties

  • Optional. The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile, and it may show up in the Venmo app as a “Connected Merchant”. Venmo profile IDs can be found in the Braintree Control Panel. Leaving this nil will use the default Venmo profile.

    Declaration

    Swift

    public var profileID: String?
    Show on GitHub

  • Whether to automatically vault the Venmo account on the client. For client-side vaulting, you must initialize BTAPIClient with a client token that was created with a customer ID. Also, paymentMethodUsage on the BTVenmoRequest must be set to .multiUse.

    If this property is set to false, you can still vault the Venmo account on your server, provided that paymentMethodUsage is not set to .singleUse. Defaults to false

    Declaration

    Swift

    public var vault: Bool
    Show on GitHub

  • If set to .multiUse, the Venmo payment will be authorized for future payments and can be vaulted. If set to .singleUse, the Venmo payment will be authorized for a one-time payment and cannot be vaulted.

    Declaration

    Swift

    public var paymentMethodUsage: BTVenmoPaymentMethodUsage
    Show on GitHub

  • Optional. The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.

    Declaration

    Swift

    public var displayName: String?
    Show on GitHub

  • Whether the customer’s billing address should be collected and displayed on the Venmo paysheet. Defaults to false

    Declaration

    Swift

    public var collectCustomerBillingAddress: Bool
    Show on GitHub

  • Whether the customer’s shipping address should be collected and displayed on the Venmo paysheet. Defaults to false

    Declaration

    Swift

    public var collectCustomerShippingAddress: Bool
    Show on GitHub

  • Indicates whether the purchase amount is the final amount. Removes “subject to change” notice in Venmo app paysheet UI. Defaults to false

    Declaration

    Swift

    public var isFinalAmount: Bool
    Show on GitHub

  • Optional. The subtotal amount of the transaction to be displayed on the paysheet. Excludes taxes, discounts, and shipping amounts.

    If this value is set, totalAmount must also be set.

    Declaration

    Swift

    public var subTotalAmount: String?
    Show on GitHub

  • Optional. The total discount amount applied on the transaction to be displayed on the paysheet.

    If this value is set, totalAmount must also be set.

    Declaration

    Swift

    public var discountAmount: String?
    Show on GitHub

  • Optional. The total tax amount for the transaction to be displayed on the paysheet.

    If this value is set, totalAmount must also be set.

    Declaration

    Swift

    public var taxAmount: String?
    Show on GitHub

  • Optional. The shipping amount for the transaction to be displayed on the paysheet.

    If this value is set, totalAmount must also be set.

    Declaration

    Swift

    public var shippingAmount: String?
    Show on GitHub

  • Optional. The grand total amount on the transaction that should be displayed on the paysheet.

    Declaration

    Swift

    public var totalAmount: String?
    Show on GitHub

  • Optional. The line items for this transaction. It can include up to 249 line items.

    If this value is set, totalAmount must also be set.

    Declaration

    Swift

    public var lineItems: [BTVenmoLineItem]?
    Show on GitHub

  • Optional. Used to determine if the customer should fallback to the web flow if Venmo app is not installed.

    Defaults to false

    Declaration

    Swift

    public var fallbackToWeb: Bool
    Show on GitHub

Initializer