BTVenmoRequest

@objcMembers
public class BTVenmoRequest : NSObject

A BTVenmoRequest specifies options that contribute to the Venmo flow

Show on GitHub

Initializer


                    
                    
                    init(paymentMethodUsage:profileID:vault:displayName:collectCustomerBillingAddress:collectCustomerShippingAddress:isFinalAmount:subTotalAmount:discountAmount:taxAmount:shippingAmount:totalAmount:lineItems:)

Initialize a BTVenmoRequest

Declaration

Swift

@objc(initWithPaymentMethodUsage:profileID:vault:displayName:collectCustomerBillingAddress:collectCustomerShippingAddress:isFinalAmount:subTotalAmount:discountAmount:taxAmount:shippingAmount:totalAmount:lineItems:)
public init(
    paymentMethodUsage: BTVenmoPaymentMethodUsage,
    profileID: String? = nil,
    vault: Bool = false,
    displayName: String? = nil,
    collectCustomerBillingAddress: Bool = false,
    collectCustomerShippingAddress: Bool = false,
    isFinalAmount: Bool = false,
    subTotalAmount: String? = nil,
    discountAmount: String? = nil,
    taxAmount: String? = nil,
    shippingAmount: String? = nil,
    totalAmount: String? = nil,
    lineItems: [BTVenmoLineItem]? = []
)

Parameters

`paymentMethodUsage`	Required: A `BTVenmoPaymentMethodUsage` that determines the usage type of a tokenized Venmo account.
`profileID`	Optional: The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile. Venmo profile IDs can be found in the Braintree Control Panel. Leaving this `nil` will use the default Venmo profile.
`vault`	Optional: 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`.
`displayName`	Optional: The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.
`collectCustomerBillingAddress`	Optional: Whether the customer’s billing address should be collected and displayed on the Venmo paysheet. Defaults to `false`.
`collectCustomerShippingAddress`	Optional: Whether the customer’s shipping address should be collected and displayed on the Venmo paysheet. Defaults to `false`.
`isFinalAmount`	Optional: Indicates whether the purchase amount is the final amount. Removes “subject to change” notice in Venmo app paysheet UI. Defaults to `false`.
`subTotalAmount`	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.
`discountAmount`	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.
`taxAmount`	Optional: The total tax amount for the transaction to be displayed on the paysheet. If this value is set, `totalAmount` must also be set.
`shippingAmount`	Optional: The shipping amount for the transaction to be displayed on the paysheet. If this value is set, `totalAmount` must also be set.
`totalAmount`	Optional: The grand total amount on the transaction that should be displayed on the paysheet.
`lineItems`	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.

Show on GitHub