ClubReady Api

<back to all web services

PaymentProfileImportEndpoint

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


@ApiResponse(Description="", ResponseType=PaymentProfileImportResponse.class, StatusCode=200)
open class PaymentProfileImportEndpoint : PaymentProfileImportRequest(), IApiKeyEndpoint
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

    /**
    * API Authentication Key
    */
    @ApiMember(Description="API Authentication Key", IsRequired=true, ParameterType="query")
    var ApiKey:String? = null

    /**
    * The ProfileToken JWT to import (see description above)
    */
    @ApiMember(Description="The ProfileToken JWT to import (see description above)", IsRequired=true)
    var ProfileToken:String? = null

    /**
    * When adding a PaymentMethod that is 'on-file' (`IsTemp == true`), the default behavior is toset this PaymentMethod as the preferred method. If you do not wish this to be the preferredmethod, you can set `DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can beomitted or `false`.For non 'on-file' PaymentMethods, this setting is ignored.
    */
    @ApiMember(Description="When adding a PaymentMethod that is 'on-file' (`IsTemp == true`), the default behavior is to\r\nset this PaymentMethod as the preferred method. If you do not wish this to be the preferred\r\nmethod, you can set `DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can be\r\nomitted or `false`.\r\n\r\nFor non 'on-file' PaymentMethods, this setting is ignored.")
    var DoNotUpdatePaymentTypePreference:Boolean? = null

    /**
    * **Conditionally Required**  When importing a ProfileToken with an OwnerType of `TempStUser`, the ownership will be changed toOwnerType of `User` with the userId of the supplied `NewOwnerId`.This is needed when a PaymentMethod is created for a User that has not been selected or created, yet.
    */
    @ApiMember(Description="**Conditionally Required**  \r\n\r\nWhen importing a ProfileToken with an OwnerType of `TempStUser`, the ownership will be changed to\r\nOwnerType of `User` with the userId of the supplied `NewOwnerId`.\r\n\r\nThis is needed when a PaymentMethod is created for a User that has not been selected or created, yet.")
    var NewOwnerId:Int? = null
}

open class PaymentProfileImportRequest
{
    var ProfileToken:String? = null
    var DoNotUpdatePaymentTypePreference:Boolean? = null
    var NewOwnerId:Int? = null
}

open class PaymentProfileImportResponse
{
    var Success:Boolean? = null
    var Message:String? = null
    var PaymentProfile:PaymentProfile? = null
}

open class PaymentProfile : IFullNameContainer
{
    var PaymentProfileId:Int? = null
    var AcctToken:String? = null
    var OwnerId:Int? = null
    var OwnerTypeId:Short? = null
    var AcctTypeId:Short? = null
    var AcctClassId:Short? = null
    var PrefixName:String? = null
    var FirstName:String? = null
    var MiddleName:String? = null
    var LastName:String? = null
    var SuffixName:String? = null
    var Address1:String? = null
    var Address2:String? = null
    var Urbanization:String? = null
    var City:String? = null
    var State:String? = null
    var PostalCode:String? = null
    var CountryCode:String? = null
    var Last4:String? = null
    var CcExpMonth:Short? = null
    var CcExpYear:Short? = null
    var IsTemp:Boolean? = null
    var IsDisabled:Boolean? = null
    var OnHoldUtc:Date? = null
    var OnHoldReasonCode:Short? = null
    var OnHoldReasonDetail:String? = null
    var AcctUpdaterFlagUtc:Date? = null
    var CreatedBy:Int? = null
    var CreatedUtc:Date? = null
    var ModifiedBy:Int? = null
    var ModifiedUtc:Date? = null
    var AcctUpdaterFlag:Boolean? = null
    var EntryModeId:Short? = null
    var ExcludeFromAcctUpdater:Boolean? = null
}

Kotlin PaymentProfileImportEndpoint DTOs

POST /sales/paymentprofile/import HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentProfileImportEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales">
  <DoNotUpdatePaymentTypePreference xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">false</DoNotUpdatePaymentTypePreference>
  <NewOwnerId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">0</NewOwnerId>
  <ProfileToken xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">String</ProfileToken>
  <ApiKey>String</ApiKey>
  <XForwardedFor>String</XForwardedFor>
</PaymentProfileImportEndpoint>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentProfileImportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">
  <Message>String</Message>
  <PaymentProfile xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Payments.PaymentsDb">
    <d2p1:AcctClassId>0</d2p1:AcctClassId>
    <d2p1:AcctToken>String</d2p1:AcctToken>
    <d2p1:AcctTypeId>0</d2p1:AcctTypeId>
    <d2p1:AcctUpdaterFlag>false</d2p1:AcctUpdaterFlag>
    <d2p1:AcctUpdaterFlagUtc>0001-01-01T00:00:00</d2p1:AcctUpdaterFlagUtc>
    <d2p1:Address1>String</d2p1:Address1>
    <d2p1:Address2>String</d2p1:Address2>
    <d2p1:CcExpMonth>0</d2p1:CcExpMonth>
    <d2p1:CcExpYear>0</d2p1:CcExpYear>
    <d2p1:City>String</d2p1:City>
    <d2p1:CountryCode>String</d2p1:CountryCode>
    <d2p1:CreatedBy>0</d2p1:CreatedBy>
    <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
    <d2p1:EntryModeId>0</d2p1:EntryModeId>
    <d2p1:ExcludeFromAcctUpdater>false</d2p1:ExcludeFromAcctUpdater>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:IsDisabled>false</d2p1:IsDisabled>
    <d2p1:IsTemp>false</d2p1:IsTemp>
    <d2p1:Last4>String</d2p1:Last4>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:MiddleName>String</d2p1:MiddleName>
    <d2p1:ModifiedBy>0</d2p1:ModifiedBy>
    <d2p1:ModifiedUtc>0001-01-01T00:00:00</d2p1:ModifiedUtc>
    <d2p1:OnHoldReasonCode>0</d2p1:OnHoldReasonCode>
    <d2p1:OnHoldReasonDetail>String</d2p1:OnHoldReasonDetail>
    <d2p1:OnHoldUtc>0001-01-01T00:00:00</d2p1:OnHoldUtc>
    <d2p1:OwnerId>0</d2p1:OwnerId>
    <d2p1:OwnerTypeId>0</d2p1:OwnerTypeId>
    <d2p1:PaymentProfileId>0</d2p1:PaymentProfileId>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:PrefixName>String</d2p1:PrefixName>
    <d2p1:State>String</d2p1:State>
    <d2p1:SuffixName>String</d2p1:SuffixName>
    <d2p1:Urbanization>String</d2p1:Urbanization>
  </PaymentProfile>
  <Success>false</Success>
</PaymentProfileImportResponse>