com.tink.rest.models.CreateTransferRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest Show documentation
A library for Tink core services
There is a newer version: 0.8.6
/**
 * NOTE: This class is auto generated by the Swagger Gradle Codegen for the following API: Tink API
 *
 * More info on this tool is available on https://github.com/Yelp/swagger-gradle-codegen
 */

package com.tink.rest.models

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass

/**
 * A Transfer on Tink represents the tentative action of requesting a payment initiation. By consequence, its success does not represent that money has been successfully transferred from one account to another because the payment initiation relays the responsibility of properly executing the monetary reallocation to the financial institution.  The source account must belong to the authenticated user. Source and destination accounts are sent in a special URI format. See below examples.
 * @property amount The amount that will be transferred. Should be positive.
 * @property credentialsId The id of the Credentials used to make the transfer. For PIS with AIS will be the credentials of which the source account belongs to. For PIS without AIS it is not linked to source account
 * @property currency The currency of the amount to be transferred. Should match the SourceUri's currency.
 * @property destinationMessage The message to the recipient. Optional for bank transfers but required for payments. If the payment recipient requires a structured (specially formatted) message, it should be set in this field.
 * @property id
 * @property sourceMessage The transaction description on the source account for the transfer.
 * @property dueDate The date when the payment or bank transfer should be executed. If no dueDate is given, it will be executed immediately.
 * @property messageType Transfer's message type, only required for BE and SEPA-EUR schemes. STRUCTURED is for PAYMENT type transfers and FREE_TEXT is for BANK_TRANSFER type transfers.
 * @property destinationUri The destination account or recipient of the transfer, in the form of a uri.
 * @property sourceUri The source account of the transfer, in the form of a uri.
 */
@JsonClass(generateAdapter = true)
data class CreateTransferRequest(
    @Json(name = "amount") var amount: Double, // TODO
    @Json(name = "currency") var currency: String,
    @Json(name = "destinationMessage") var destinationMessage: String,
    @Json(name = "destinationUri") var destinationUri: String,
    @Json(name = "sourceUri") var sourceUri: String,
    @Json(name = "redirectUri") var redirectUri: String,
    @Json(name = "credentialsId") var credentialsId: String? = null,
    @Json(name = "id") var id: String? = null,
    @Json(name = "sourceMessage") var sourceMessage: String? = null,
    @Json(name = "dueDate") var dueDate: Long? = null,
    @Json(name = "messageType") var messageType: MessageTypeEnum? = null
) {
    /**
     * Transfer's message type, only required for BE and SEPA-EUR schemes. STRUCTURED is for PAYMENT type transfers and FREE_TEXT is for BANK_TRANSFER type transfers.
     * Values: STRUCTURED, FREE_TEXT
     */
    @JsonClass(generateAdapter = false)
    enum class MessageTypeEnum(val value: String) {
        @Json(name = "STRUCTURED")
        STRUCTURED("STRUCTURED"),
        @Json(name = "FREE_TEXT")
        FREE_TEXT("FREE_TEXT")
    }
}