Builder
The builder used to create PaymentParameters. Create a Builder for a payment of a specific amount of money with provided idempotencyKey.
Functions
Allows successful authorization of a part of the requested amountMoney. Defaults to false.
Records a fee to the app developer, taken from amountMoney.
Controls whether this payment will, when made, be completed (true
) or only authorized (false
). Payments that are only authorized need to be either completed or canceled later, using the Connect v2 CompletePayment API and passing the payment_id
returned from authorization.
Associates a customer to the payment being constructed by this builder.
Sets the action taken, for payments with autocomplete equal to false, after the payment's delayDuration has expired. Default is DelayAction.CANCEL if not explicitly set.
Sets the duration between payment creation and automatic cancellation, for payments with autocomplete equal to false.
Sets the location ID of the location taking this payment. Defaults to the location id from authorization.
Sets an arbitrary note onto the payment.
Associates an order to the payment being constructed by this builder.
Sets the processing mode parameter to determine whether the current payment needs to be processed online or offline.
Associates an arbitrary reference to the payment being constructed by this builder.
Assigns a statement description string.
Sets the TeamMember ID to associate with this payment.
Adds a tip amount to the builder, an amount in addition to amountMoney treated as a tip.