Class PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder
- java.lang.Object
-
- com.checkout.handlepaymentsandpayouts.flow.paymentsessionscomplete.requests.PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder
-
- Enclosing class:
- PaymentSessionWithPaymentRequest
public static class PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder extends java.lang.Object
-
-
Method Summary
-
-
-
Method Detail
-
sessionData
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder sessionData(java.lang.String sessionData)
A unique token representing the additional customer data captured by Flow, as received from the handleSubmit callback. Do not log or store this value.- Returns:
this.
-
amount
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder amount(java.lang.Long amount)
The payment amount. Provide a value of 0 to perform a card verification. The amount must be provided in the minor currency unit.- Returns:
this.
-
currency
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder currency(Currency currency)
The three-letter ISO currency code- Returns:
this.
-
billing
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder billing(Billing billing)
The billing details.- Returns:
this.
-
successUrl
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder successUrl(java.lang.String successUrl)
Overrides the default success redirect URL configured on your account, for payment methods that require a redirect.- Returns:
this.
-
failureUrl
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder failureUrl(java.lang.String failureUrl)
Overrides the default failure redirect URL configured on your account, for payment methods that require a redirect.- Returns:
this.
-
paymentMethodType
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder paymentMethodType(PaymentType paymentMethodType)
Default: "Regular" Must be specified for card-not-present (CNP) payments. For example, a recurring mail order / telephone order (MOTO) payment.- Returns:
this.
-
billingDescriptor
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder billingDescriptor(BillingDescriptor billingDescriptor)
A description of the purchase, which is displayed on the customer's statement.- Returns:
this.
-
reference
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder reference(java.lang.String reference)
A reference you can use to identify the payment. For example, an order number. For Amex payments, this must be at most 30 characters. For Benefit payments, the reference must be a unique alphanumeric value. For iDEAL payments, the reference is required and must be an alphanumeric value with a 35-character limit.- Returns:
this.
-
description
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder description(java.lang.String description)
A description for the payment.- Returns:
this.
-
customer
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder customer(Customer customer)
The customer's details. Required if source.type is tamara.- Returns:
this.
-
shipping
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder shipping(Shipping shipping)
The shipping details- Returns:
this.
-
recipient
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder recipient(Recipient recipient)
Information about the recipient of the payment's funds. Applies to Account Funding Transactions, and VISA or Mastercard domestic UK transactions processed by financial institutions.- Returns:
this.
-
processing
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder processing(Processing processing)
Use the processing object to influence or override the data sent during card processing- Returns:
this.
-
instruction
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder instruction(Instruction instruction)
Details about the payment instruction.- Returns:
this.
-
processingChannelId
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder processingChannelId(java.lang.String processingChannelId)
The processing channel to use for the payment.- Returns:
this.
-
paymentMethodConfiguration
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder paymentMethodConfiguration(PaymentMethodConfiguration paymentMethodConfiguration)
Configurations for payment method-specific settings.- Returns:
this.
-
items
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder items(java.util.List<Item> items)
The line items in the order.- Returns:
this.
-
amountAllocations
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder amountAllocations(java.util.List<AmountAllocation> amountAllocations)
The sub-entities that the payment is being processed on behalf of.- Returns:
this.
-
risk
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder risk(Risk risk)
Configures the risk assessment performed during payment processing.- Returns:
this.
-
displayName
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder displayName(java.lang.String displayName)
The merchant's display name.- Returns:
this.
-
metadata
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder metadata(java.util.Map<java.lang.String,java.lang.Object> metadata)
Allows you to store additional information about a transaction with custom fields and up to five user-defined fields, which can be used for reporting purposes. You can supply fields of type string, number, and boolean within the metadata object. Arrays and objects are not supported. You can provide up to 18 metadata fields per API call, but the value of each field must not exceed 255 characters in length. You can also reference metadata properties in your custom rules for Fraud Detection. For example, $coupon_code = '1234’.- Returns:
this.
-
locale
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder locale(LocaleType locale)
Default: "en-GB" Creates a translated version of the page in the specified language.- Returns:
this.
-
threeds
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder threeds(Threeds threeds)
Information required for 3D Secure authentication payments.- Returns:
this.
-
sender
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder sender(AbstractSender sender)
The sender of the payment.- Returns:
this.
-
capture
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder capture(java.lang.Boolean capture)
Default: true Specifies whether to capture the payment, if applicable.- Returns:
this.
-
captureOn
public PaymentSessionWithPaymentRequest.PaymentSessionWithPaymentRequestBuilder captureOn(java.time.Instant captureOn)
A timestamp specifying when to capture the payment, as an ISO 8601 code. If a value is provided, capture is automatically set to true.- Returns:
this.
-
build
public PaymentSessionWithPaymentRequest build()
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
-