/*
 * Copyright 2018-2024 adorsys GmbH & Co KG
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version. This program is distributed in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see https://www.gnu.org/licenses/.
 *
 * This project is also available under a separate commercial license. You can
 * contact us at sales@adorsys.com.
 */

package de.adorsys.psd2.consent.api.pis.proto;

import de.adorsys.psd2.xs2a.core.profile.PaymentType;
import de.adorsys.psd2.xs2a.core.tpp.TppRedirectUri;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
@Schema(description = "Pis payment cancellation request", name = "PisPaymentCancellationRequest")
public class PisPaymentCancellationRequest {
    @Schema(description = "Payment type: BULK, SINGLE or PERIODIC.", requiredMode = Schema.RequiredMode.REQUIRED, example = "SINGLE")
    private PaymentType paymentType;
    @Schema(description = "Payment product", requiredMode = Schema.RequiredMode.REQUIRED, example = "sepa-credit-transfers")
    private String paymentProduct;
    @Schema(description = "ASPSP identifier of the payment", requiredMode = Schema.RequiredMode.REQUIRED, example = "bf489af6-a2cb-4b75-b71d-d66d58b934d7")
    private String encryptedPaymentId;
    @Schema(description = "TPP's choice of authorisation method", requiredMode = Schema.RequiredMode.REQUIRED, example = "TRUE | FALSE")
    private Boolean tppExplicitAuthorisationPreferred;
    @Schema(description = "TPP redirect URIs", requiredMode = Schema.RequiredMode.REQUIRED)
    private TppRedirectUri tppRedirectUri;
}
