Package com.checkout.handlepaymentsandpayouts.payments.postpayments.requests.unreferencedrefundrequest

Class UnreferencedRefundRequest

  • public final class UnreferencedRefundRequest
extends java.lang.Object
    Request a payment or payout Send a payment or payout.Note: successful payout requests will always return a 202 response.

    • Constructor Detail

      • UnreferencedRefundRequest

        public UnreferencedRefundRequest()

      • UnreferencedRefundRequest

        public UnreferencedRefundRequest​(Source source,
                                 AbstractDestination destination,
                                 java.lang.Integer amount,
                                 java.lang.String currency,
                                 java.lang.String paymentType,
                                 java.lang.String processingChannelId,
                                 Instruction instruction,
                                 java.lang.String reference,
                                 java.util.Map<java.lang.String,​java.lang.Object> metadata,
                                 java.lang.String previousPaymentId,
                                 Segment segment,
                                 Processing processing)
        Creates a new UnreferencedRefundRequest instance.
        Parameters:
        source - The source of the unreferenced refund. [Required]
        destination - The destination of the unreferenced refund. [Required]
        amount - The amount of the payment [Required] >= 1
        currency - The three-letter ISO currency code of the payment. [Required] 3 characters
        paymentType - The type of the payment [Required]
        processingChannelId - The processing channel identifier [Required] ^(pc)_(\w{26})$
        instruction - Additional details about the unreferenced refund instruction. [Optional]
        reference - An internal reference you can later use to identify this payment [Optional]
        metadata - A set of key-value pairs that you can attach to the refund request. It can be useful for storing additional information in a structured format. Note: This object only allows one level of depth, so cannot accept non-primitive data types such as objects or arrays. [Optional]
        previousPaymentId - The previous related payment identifier. This could be the ID of the payment that you want to refund. [Optional]
        segment - The dimension details about business segment for payment request. At least one dimension required. [Optional]
        processing - Returns information related to the processing of the payment. [Optional]

    • Method Detail

      • getSource

        public Source getSource()
        The source of the unreferenced refund. [Required]

      • getDestination

        public AbstractDestination getDestination()
        The destination of the unreferenced refund. [Required]

      • getAmount

        public java.lang.Integer getAmount()
        The amount of the payment [Required] >= 1

      • getCurrency

        public java.lang.String getCurrency()
        The three-letter ISO currency code of the payment. [Required] 3 characters

      • getPaymentType

        public java.lang.String getPaymentType()
        The type of the payment [Required]

      • getProcessingChannelId

        public java.lang.String getProcessingChannelId()
        The processing channel identifier [Required] ^(pc)_(\w{26})$

      • getInstruction

        public Instruction getInstruction()
        Additional details about the unreferenced refund instruction. [Optional]

      • getReference

        public java.lang.String getReference()
        An internal reference you can later use to identify this payment [Optional]

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.Object> getMetadata()
        A set of key-value pairs that you can attach to the refund request. It can be useful for storing additional information in a structured format. Note: This object only allows one level of depth, so cannot accept non-primitive data types such as objects or arrays. [Optional]

      • getPreviousPaymentId

        public java.lang.String getPreviousPaymentId()
        The previous related payment identifier. This could be the ID of the payment that you want to refund. [Optional]

      • getSegment

        public Segment getSegment()
        The dimension details about business segment for payment request. At least one dimension required. [Optional]

      • getProcessing

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

      • setSource

        public void setSource​(Source source)
        The source of the unreferenced refund. [Required]

      • setDestination

        public void setDestination​(AbstractDestination destination)
        The destination of the unreferenced refund. [Required]

      • setAmount

        public void setAmount​(java.lang.Integer amount)
        The amount of the payment [Required] >= 1

      • setCurrency

        public void setCurrency​(java.lang.String currency)
        The three-letter ISO currency code of the payment. [Required] 3 characters

      • setPaymentType

        public void setPaymentType​(java.lang.String paymentType)
        The type of the payment [Required]

      • setProcessingChannelId

        public void setProcessingChannelId​(java.lang.String processingChannelId)
        The processing channel identifier [Required] ^(pc)_(\w{26})$

      • setInstruction

        public void setInstruction​(Instruction instruction)
        Additional details about the unreferenced refund instruction. [Optional]

      • setReference

        public void setReference​(java.lang.String reference)
        An internal reference you can later use to identify this payment [Optional]

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.Object> metadata)
        A set of key-value pairs that you can attach to the refund request. It can be useful for storing additional information in a structured format. Note: This object only allows one level of depth, so cannot accept non-primitive data types such as objects or arrays. [Optional]

      • setPreviousPaymentId

        public void setPreviousPaymentId​(java.lang.String previousPaymentId)
        The previous related payment identifier. This could be the ID of the payment that you want to refund. [Optional]

      • setSegment

        public void setSegment​(Segment segment)
        The dimension details about business segment for payment request. At least one dimension required. [Optional]

      • setProcessing

        public void setProcessing​(Processing processing)
        Returns information related to the processing of the payment. [Optional]

      • 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