tech.alexib.plaid.client.model.PaymentInitiationRecipientCreateRequest.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2020 Alexi Bre
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package tech.alexib.plaid.client.model

import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable

/**
 * PaymentInitiationRecipientCreateRequest defines the request schema for
 * `/payment_initiation/recipient/create`
 * @param clientId Your Plaid API `client_id`.
 * @param secret Your Plaid API `secret`.
 * @param name The name of the recipient
 * @param iban The International Bank Account Number (IBAN) for the recipient. If BACS data is not
 * provided, an IBAN is required.
 * @param address The optional address of the payment recipient. This object is not currently
 * required to make payments from UK institutions and should not be populated, though may be necessary
 * for future European expansion.
 */
@Serializable
data class PaymentInitiationRecipientCreateRequest(
    @SerialName("client_id")
    val clientId: String? = null,
    @SerialName("secret")
    val secret: String? = null,
    @SerialName("name")
    val name: String,
    @SerialName("iban")
    val iban: String? = null,
    @SerialName("bacs")
    val bacs: NullableRecipientBACS? = null,
    @SerialName("address")
    val address: PaymentInitiationAddress? = null
)