Builder

class Builder(amount: Money, idempotencyKey: String)

The builder used to create PaymentParameters. Create a Builder for a payment of a specific amount of money with provided idempotencyKey.

Constructors

Link copied to clipboard
constructor(amount: Money, idempotencyKey: String)

Functions

Link copied to clipboard

Allows successful authorization of a part of the requested amountMoney. Defaults to false.

Link copied to clipboard

Records a fee to the app developer, taken from amountMoney.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Associates a customer to the payment being constructed by this builder.

Link copied to clipboard

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.

Link copied to clipboard

Sets the duration between payment creation and automatic cancellation, for payments with autocomplete equal to false.

Link copied to clipboard

Sets the location ID of the location taking this payment. Defaults to the location id from authorization.

Link copied to clipboard

Sets an arbitrary note onto the payment.

Link copied to clipboard

Associates an order to the payment being constructed by this builder.

Link copied to clipboard

Sets the processing mode parameter to determine whether the current payment needs to be processed online or offline.

Link copied to clipboard

Associates an arbitrary reference to the payment being constructed by this builder.

Link copied to clipboard

Assigns a statement description string.

Link copied to clipboard

Sets the TeamMember ID to associate with this payment.

Link copied to clipboard

Adds a tip amount to the builder, an amount in addition to amountMoney treated as a tip.