tech.carpentum.sdk.payment.model.PaymentOperatorOutgoing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payment-client-v2 Show documentation
Carpentum Payment system Java SDK
The newest version!
//THE FILE IS GENERATED, DO NOT MODIFY IT MANUALLY!!!
package tech.carpentum.sdk.payment.model;

import com.squareup.moshi.JsonClass;
import java.util.Objects;
import java.util.Optional;
import org.jetbrains.annotations.NotNull;
import tech.carpentum.sdk.payment.internal.generated.model.*;
import tech.carpentum.sdk.payment.model.*;

/** PaymentOperatorOutgoing
 *
 * PaymentOperator is a financial institution that manages transactions in your customer's account (such as banks, card payment processors, mobile wallets and so on).
The payment operators are assigned to the payment methods according to your account configuration.

For supported payment operators please refer to [`GET /payment-operators`](#operations-Payments-getPaymentOperators).
 *
 * 
 *
 * The model class is immutable.
 * Use static {@link #builder} method to create a new {@link Builder} instance to build the model class instance.
 *
 */
@JsonClass(generateAdapter = false)
public interface PaymentOperatorOutgoing extends PaymentOperator {

    /** One of following can serve as Payment Operator:

 * Financial or other institution (such as bank, card payment processor, ...) that manages transactions for your customers
 * Mobile wallet
 * Blockchain protocol for crypto currency payments

Customer is informed with the payment instructions where funds have to be transferred efficiently based on the selected Payment operator.
For getting list of the available payment options for payins use [POST /payins/!availablePaymentOptions](#operations-Incoming_payments-availablePaymentOptions) API, for payouts use [POST /payouts/!availablePaymentOptions](#operations-Outgoing_payments-availablePaymentOptions) API. */
    @NotNull String getCode();

    @NotNull String getName();

    @NotNull Optional getCustomerTransactionFee();

    @NotNull static Builder builder(PaymentOperatorOutgoing copyOf) {
        Builder builder = builder();
        builder.code(copyOf.getCode());
        builder.name(copyOf.getName());
        builder.customerTransactionFee(copyOf.getCustomerTransactionFee().orElse(null));
        return builder;
    }

    @NotNull static Builder builder() {
        return new PaymentOperatorReverseInheritanceImpl.BuilderImpl("PaymentOperatorOutgoing");
    }

    /** Builder for {@link PaymentOperatorOutgoing} model class. */
    interface Builder {

        /**
          * Set {@link PaymentOperatorOutgoing#getCode} property.
          *
          * One of following can serve as Payment Operator:

 * Financial or other institution (such as bank, card payment processor, ...) that manages transactions for your customers
 * Mobile wallet
 * Blockchain protocol for crypto currency payments

Customer is informed with the payment instructions where funds have to be transferred efficiently based on the selected Payment operator.
For getting list of the available payment options for payins use [POST /payins/!availablePaymentOptions](#operations-Incoming_payments-availablePaymentOptions) API, for payouts use [POST /payouts/!availablePaymentOptions](#operations-Outgoing_payments-availablePaymentOptions) API.
          */
        @NotNull Builder code(String code);


        /**
          * Set {@link PaymentOperatorOutgoing#getName} property.
          *
          * 
          */
        @NotNull Builder name(String name);


        /**
          * Set {@link PaymentOperatorOutgoing#getCustomerTransactionFee} property.
          *
          * 
          */
        @NotNull Builder customerTransactionFee(CustomerTransactionFee customerTransactionFee);


        /**
         * Create new instance of {@link PaymentOperatorOutgoing} model class with the builder instance properties.
         *
         * @throws NullPointerException in case required properties are not specified.
         */
        @NotNull PaymentOperatorOutgoing build();

    }
}