Package com.checkout.handlepaymentsandpayouts.payments.postpayments.responses.requestapaymentorpayoutresponsecreated

Class RequestAPaymentOrPayoutResponseCreated

  • public final class RequestAPaymentOrPayoutResponseCreated
extends Resource
    Request a payment or payout Response 201 Payment processed successfully

    • Constructor Detail

      • RequestAPaymentOrPayoutResponseCreated

        public RequestAPaymentOrPayoutResponseCreated​(java.lang.String id,
                                              java.lang.String actionId,
                                              java.lang.Integer amount,
                                              Currency currency,
                                              java.lang.Boolean approved,
                                              StatusType status,
                                              java.lang.String responseCode,
                                              java.time.Instant processedOn,
                                              java.lang.Integer amountRequested,
                                              java.lang.String authCode,
                                              java.lang.String responseSummary,
                                              java.lang.String expiresOn,
                                              Threeds threeds,
                                              Risk risk,
                                              AbstractSource source,
                                              Customer customer,
                                              Balances balances,
                                              java.lang.String reference,
                                              Subscription subscription,
                                              Processing processing,
                                              java.lang.String eci,
                                              java.lang.String schemeId,
                                              Retry retry)
        Creates a new RequestAPaymentOrPayoutResponseCreated instance.
        Parameters:
        id - The payment's unique identifier [Required]
        actionId - The unique identifier for the action performed against this payment [Required] ^(act)_(\w{26})$ 30 characters
        amount - The payment amount. [Required]
        currency - The three-letter ISO currency code of the payment [Required] 3 characters
        approved - Whether or not the authorization or capture was successful [Required]
        status - The status of the payment [Required]
        responseCode - The Gateway response code [Required]
        processedOn - The date/time the payment was processed [Required]
        amountRequested - The full amount from the original authorization, if a partial authorization was requested and approved. [Optional]
        authCode - The acquirer authorization code if the payment was authorized [Optional]
        responseSummary - The Gateway response summary [Optional]
        expiresOn - The timestamp (ISO 8601 code) for when the authorization's validity period expires [Optional]
        threeds - Provides 3D Secure enrollment status if the payment was downgraded to non-3D Secure [Optional]
        risk - Returns the payment's risk assessment results [Optional]
        source - The source of the payment [Optional]
        customer - The customer associated with the payment, if provided in the request [Optional]
        balances - The payment balances [Optional]
        reference - Your reference for the payment [Optional]
        subscription - The details of the subscription. [Optional]
        processing - Returns information related to the processing of the payment [Optional]
        eci - The final Electronic Commerce Indicator (ECI) security level used to authorize the payment. Applicable for 3D Secure and network token payments [Optional]
        schemeId - The scheme transaction identifier [Optional]
        retry - Configuration relating to asynchronous retries [Optional]

      • RequestAPaymentOrPayoutResponseCreated

        public RequestAPaymentOrPayoutResponseCreated()

    • Method Detail

      • getId

        public java.lang.String getId()
        The payment's unique identifier [Required]

      • getActionId

        public java.lang.String getActionId()
        The unique identifier for the action performed against this payment [Required] ^(act)_(\w{26})$ 30 characters

      • getAmount

        public java.lang.Integer getAmount()
        The payment amount. [Required]

      • getCurrency

        public Currency getCurrency()
        The three-letter ISO currency code of the payment [Required] 3 characters

      • getApproved

        public java.lang.Boolean getApproved()
        Whether or not the authorization or capture was successful [Required]

      • getStatus

        public StatusType getStatus()
        The status of the payment [Required]

      • getResponseCode

        public java.lang.String getResponseCode()
        The Gateway response code [Required]

      • getProcessedOn

        public java.time.Instant getProcessedOn()
        The date/time the payment was processed [Required]

      • getAmountRequested

        public java.lang.Integer getAmountRequested()
        The full amount from the original authorization, if a partial authorization was requested and approved. [Optional]

      • getAuthCode

        public java.lang.String getAuthCode()
        The acquirer authorization code if the payment was authorized [Optional]

      • getResponseSummary

        public java.lang.String getResponseSummary()
        The Gateway response summary [Optional]

      • getExpiresOn

        public java.lang.String getExpiresOn()
        The timestamp (ISO 8601 code) for when the authorization's validity period expires [Optional]

      • getThreeds

        public Threeds getThreeds()
        Provides 3D Secure enrollment status if the payment was downgraded to non-3D Secure [Optional]

      • getRisk

        public Risk getRisk()
        Returns the payment's risk assessment results [Optional]

      • getSource

        public AbstractSource getSource()
        The source of the payment [Optional]

      • getCustomer

        public Customer getCustomer()
        The customer associated with the payment, if provided in the request [Optional]

      • getBalances

        public Balances getBalances()
        The payment balances [Optional]

      • getReference

        public java.lang.String getReference()
        Your reference for the payment [Optional]

      • getSubscription

        public Subscription getSubscription()
        The details of the subscription. [Optional]

      • getProcessing

        public Processing getProcessing()
        Returns information related to the processing of the payment [Optional]

      • getEci

        public java.lang.String getEci()
        The final Electronic Commerce Indicator (ECI) security level used to authorize the payment. Applicable for 3D Secure and network token payments [Optional]

      • getSchemeId

        public java.lang.String getSchemeId()
        The scheme transaction identifier [Optional]

      • getRetry

        public Retry getRetry()
        Configuration relating to asynchronous retries [Optional]

      • toString

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

      • equals

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

      • canEqual

        protected boolean canEqual​(java.lang.Object other)
        Overrides:
        canEqual in class Resource