Package com.checkout.handlepaymentsandpayouts.flow.paymentsessionscomplete.requests

Class PaymentSessionWithPaymentRequest

  • public final class PaymentSessionWithPaymentRequest
extends java.lang.Object

    • Constructor Detail

      • PaymentSessionWithPaymentRequest

        public PaymentSessionWithPaymentRequest()

      • PaymentSessionWithPaymentRequest

        public PaymentSessionWithPaymentRequest​(java.lang.String sessionData,
                                        java.lang.Long amount,
                                        Currency currency,
                                        Billing billing,
                                        java.lang.String successUrl,
                                        java.lang.String failureUrl,
                                        PaymentType paymentMethodType,
                                        BillingDescriptor billingDescriptor,
                                        java.lang.String reference,
                                        java.lang.String description,
                                        Customer customer,
                                        Shipping shipping,
                                        Recipient recipient,
                                        Processing processing,
                                        Instruction instruction,
                                        java.lang.String processingChannelId,
                                        PaymentMethodConfiguration paymentMethodConfiguration,
                                        java.util.List<Item> items,
                                        java.util.List<AmountAllocation> amountAllocations,
                                        Risk risk,
                                        java.lang.String displayName,
                                        java.util.Map<java.lang.String,​java.lang.Object> metadata,
                                        LocaleType locale,
                                        Threeds threeds,
                                        AbstractSender sender,
                                        java.lang.Boolean capture,
                                        java.time.Instant captureOn)
        Creates a new PaymentSessionWithPaymentRequest instance.
        Parameters:
        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.
        amount - The payment amount. Provide a value of 0 to perform a card verification. The amount must be provided in the minor currency unit.
        currency - The three-letter ISO currency code
        billing - The billing details.
        successUrl - Overrides the default success redirect URL configured on your account, for payment methods that require a redirect.
        failureUrl - Overrides the default failure redirect URL configured on your account, for payment methods that require a redirect.
        paymentMethodType - Default: "Regular" Must be specified for card-not-present (CNP) payments. For example, a recurring mail order / telephone order (MOTO) payment.
        billingDescriptor - A description of the purchase, which is displayed on the customer's statement.
        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.
        description - A description for the payment.
        customer - The customer's details. Required if source.type is tamara.
        shipping - The shipping details
        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.
        processing - Use the processing object to influence or override the data sent during card processing
        instruction - Details about the payment instruction.
        processingChannelId - The processing channel to use for the payment.
        paymentMethodConfiguration - Configurations for payment method-specific settings.
        items - The line items in the order.
        amountAllocations - The sub-entities that the payment is being processed on behalf of.
        risk - Configures the risk assessment performed during payment processing.
        displayName - The merchant's display name.
        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’.
        locale - Default: "en-GB" Creates a translated version of the page in the specified language.
        threeds - Information required for 3D Secure authentication payments.
        sender - The sender of the payment.
        capture - Default: true Specifies whether to capture the payment, if applicable.
        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.

    • Method Detail

      • getSessionData

        public java.lang.String getSessionData()
        A unique token representing the additional customer data captured by Flow, as received from the handleSubmit callback. Do not log or store this value.

      • getAmount

        public java.lang.Long getAmount()
        The payment amount. Provide a value of 0 to perform a card verification. The amount must be provided in the minor currency unit.

      • getCurrency

        public Currency getCurrency()
        The three-letter ISO currency code

      • getBilling

        public Billing getBilling()
        The billing details.

      • getSuccessUrl

        public java.lang.String getSuccessUrl()
        Overrides the default success redirect URL configured on your account, for payment methods that require a redirect.

      • getFailureUrl

        public java.lang.String getFailureUrl()
        Overrides the default failure redirect URL configured on your account, for payment methods that require a redirect.

      • getPaymentMethodType

        public PaymentType getPaymentMethodType()
        Default: "Regular" Must be specified for card-not-present (CNP) payments. For example, a recurring mail order / telephone order (MOTO) payment.

      • getBillingDescriptor

        public BillingDescriptor getBillingDescriptor()
        A description of the purchase, which is displayed on the customer's statement.

      • getReference

        public java.lang.String getReference()
        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.

      • getDescription

        public java.lang.String getDescription()
        A description for the payment.

      • getCustomer

        public Customer getCustomer()
        The customer's details. Required if source.type is tamara.

      • getShipping

        public Shipping getShipping()
        The shipping details

      • getRecipient

        public Recipient getRecipient()
        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.

      • getProcessing

        public Processing getProcessing()
        Use the processing object to influence or override the data sent during card processing

      • getInstruction

        public Instruction getInstruction()
        Details about the payment instruction.

      • getProcessingChannelId

        public java.lang.String getProcessingChannelId()
        The processing channel to use for the payment.

      • getPaymentMethodConfiguration

        public PaymentMethodConfiguration getPaymentMethodConfiguration()
        Configurations for payment method-specific settings.

      • getItems

        public java.util.List<Item> getItems()
        The line items in the order.

      • getAmountAllocations

        public java.util.List<AmountAllocation> getAmountAllocations()
        The sub-entities that the payment is being processed on behalf of.

      • getRisk

        public Risk getRisk()
        Configures the risk assessment performed during payment processing.

      • getDisplayName

        public java.lang.String getDisplayName()
        The merchant's display name.

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
        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’.

      • getLocale

        public LocaleType getLocale()
        Default: "en-GB" Creates a translated version of the page in the specified language.

      • getThreeds

        public Threeds getThreeds()
        Information required for 3D Secure authentication payments.

      • getSender

        public AbstractSender getSender()
        The sender of the payment.

      • getCapture

        public java.lang.Boolean getCapture()
        Default: true Specifies whether to capture the payment, if applicable.

      • getCaptureOn

        public java.time.Instant getCaptureOn()
        A timestamp specifying when to capture the payment, as an ISO 8601 code. If a value is provided, capture is automatically set to true.

      • setSessionData

        public void setSessionData​(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.

      • setAmount

        public void setAmount​(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.

      • setCurrency

        public void setCurrency​(Currency currency)
        The three-letter ISO currency code

      • setBilling

        public void setBilling​(Billing billing)
        The billing details.

      • setSuccessUrl

        public void setSuccessUrl​(java.lang.String successUrl)
        Overrides the default success redirect URL configured on your account, for payment methods that require a redirect.

      • setFailureUrl

        public void setFailureUrl​(java.lang.String failureUrl)
        Overrides the default failure redirect URL configured on your account, for payment methods that require a redirect.

      • setPaymentMethodType

        public void setPaymentMethodType​(PaymentType paymentMethodType)
        Default: "Regular" Must be specified for card-not-present (CNP) payments. For example, a recurring mail order / telephone order (MOTO) payment.

      • setBillingDescriptor

        public void setBillingDescriptor​(BillingDescriptor billingDescriptor)
        A description of the purchase, which is displayed on the customer's statement.

      • setReference

        public void setReference​(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.

      • setDescription

        public void setDescription​(java.lang.String description)
        A description for the payment.

      • setCustomer

        public void setCustomer​(Customer customer)
        The customer's details. Required if source.type is tamara.

      • setShipping

        public void setShipping​(Shipping shipping)
        The shipping details

      • setRecipient

        public void setRecipient​(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.

      • setProcessing

        public void setProcessing​(Processing processing)
        Use the processing object to influence or override the data sent during card processing

      • setInstruction

        public void setInstruction​(Instruction instruction)
        Details about the payment instruction.

      • setProcessingChannelId

        public void setProcessingChannelId​(java.lang.String processingChannelId)
        The processing channel to use for the payment.

      • setPaymentMethodConfiguration

        public void setPaymentMethodConfiguration​(PaymentMethodConfiguration paymentMethodConfiguration)
        Configurations for payment method-specific settings.

      • setItems

        public void setItems​(java.util.List<Item> items)
        The line items in the order.

      • setAmountAllocations

        public void setAmountAllocations​(java.util.List<AmountAllocation> amountAllocations)
        The sub-entities that the payment is being processed on behalf of.

      • setRisk

        public void setRisk​(Risk risk)
        Configures the risk assessment performed during payment processing.

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        The merchant's display name.

      • setMetadata

        public void setMetadata​(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’.

      • setLocale

        public void setLocale​(LocaleType locale)
        Default: "en-GB" Creates a translated version of the page in the specified language.

      • setThreeds

        public void setThreeds​(Threeds threeds)
        Information required for 3D Secure authentication payments.

      • setSender

        public void setSender​(AbstractSender sender)
        The sender of the payment.

      • setCapture

        public void setCapture​(java.lang.Boolean capture)
        Default: true Specifies whether to capture the payment, if applicable.

      • setCaptureOn

        public void setCaptureOn​(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.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object