/* Options:
Date: 2024-11-24 13:21:52
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://clubready.com/api/current

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: PaymentProfileBalanceInquiryEndpoint.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*


@Route(Path="/sales/paymentProfile/balanceInquiry", Verbs="GET")
@ApiResponse(Description="Looks up the balance of a payment profile created by the Vault API", ResponseType=PaymentProfileBalanceInquiryResponse.class, StatusCode=200)
open class PaymentProfileBalanceInquiryEndpoint : PaymentProfileBalanceInquiryRequest(), IReturn<PamentProfileBalanceInquiryEndpointResponse>, IApiKeyEndpoint
{
    /**
    * Api Authentication Key
    */
    @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    var ApiKey:String? = null

    /**
    * Store Id
    */
    @ApiMember(Description="Store Id", IsRequired=true, ParameterType="query")
    var StoreId:Int? = null

    /**
    * Encoded data uniquely identifying the payment profile.  Long term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater).  The length is usually 80 characters.
    */
    @ApiMember(Description="\r\nEncoded data uniquely identifying the payment profile.  \r\nLong term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater).  \r\nThe length is usually 80 characters.", IsRequired=true)
    var AcctToken:String? = null

    /**
    * Encoded data containing non-PCI information about the Payment Profile.  ProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes,it cannot be accepted and a new profile will have to be created with a new AcctToken. The timevalidation is to prevent old tokens from be re-played at a later time.  The length is variable, but generally around 1,000 characters.
    */
    @ApiMember(Description="\r\nEncoded data containing non-PCI information about the Payment Profile.  \r\n\r\nProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes,\r\nit cannot be accepted and a new profile will have to be created with a new AcctToken. The time\r\nvalidation is to prevent old tokens from be re-played at a later time.  \r\n\r\nThe length is variable, but generally around 1,000 characters.")
    var ProfileToken:String? = null
    companion object { private val responseType = PamentProfileBalanceInquiryEndpointResponse::class.java }
    override fun getResponseType(): Any? = PaymentProfileBalanceInquiryEndpoint.responseType
}

open class PamentProfileBalanceInquiryEndpointResponse
{
    var Success:Boolean? = null
    var Last4:String? = null
    var AccountBalance:BigDecimal? = null
    var ResponseCode:String? = null
    var Message:String? = null
}

open interface IApiKeyEndpoint
{
    var ApiKey:String?
}

open class PaymentProfileBalanceInquiryRequest
{
    var TerminalIpAddress:String? = null
    var AcctToken:String? = null
    var ProfileToken:String? = null
    var StoreId:Int? = null
}