TicketUserServices

<back to all web services

RecurringPaymentCreateRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin
The following routes are available for this service:
POST/recurringPayments
import java.math.*
import java.util.*
import net.servicestack.client.*


open class RecurringPaymentCreateRequest
{
    var phoneVerificationNumber:String? = null
    var token:String? = null
    var panLastFour:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var deviceId:String? = null
    var monthlyPrice:Int? = null
    var subscriptionLength:Int? = null
    var chargeFirstMonth:Boolean? = null
    var ownerId:Int? = null
    var ownerCardTypeId:Int? = null
    var paymentTokenId:String? = null
    var transactionFee:BigDecimal? = null
    var currency:String? = null
    var mode:String? = null
    var startDate:Date? = null
    var lastPayment:Date? = null
    var nextPayment:Date? = null
    var jsonResponse:String? = null
    var termsVersion:String? = null
    var termsAcceptedAt:Date? = null
}

open class RecurringPaymentGetResult
{
    var item:RecurringPayment? = null
    var alreadyExisted:Boolean? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class RecurringPayment
{
    var id:Int? = null
    var status:String? = null
    var phoneVerificationNumber:String? = null
    var deviceId:String? = null
    var panLastFour:String? = null
    var expYear:String? = null
    var expMonth:String? = null
    var token:String? = null
    var monthlyPrice:Int? = null
    var subscriptionLength:Int? = null
    var monthsPaid:Int? = null
    var chargeFirstMonth:Boolean? = null
    @References(EventOwner.class)
    var ownerId:Int? = null

    var ownerCardTypeId:Int? = null
    @StringLength(2147483647)
    var jsonResponse:String? = null

    var startDate:Date? = null
    var lastPayment:Date? = null
    var nextPayment:Date? = null
    var paymentTokenId:String? = null
    var declinedCounter:Int? = null
    var transactionFee:BigDecimal? = null
    var termsVersion:String? = null
    var termsAcceptedAt:Date? = null
    var currency:String? = null
    var mode:String? = null
    var lastDeclineReason:String? = null
    var lastDeclineDate:Date? = null
    var lastDunningStage:Short? = null
    var lastDunningNotifiedAt:Date? = null
}

Kotlin RecurringPaymentCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /recurringPayments HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RecurringPaymentCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ChargeFirstMonth>false</ChargeFirstMonth>
  <Currency>String</Currency>
  <DeviceId>String</DeviceId>
  <ExpMonth>String</ExpMonth>
  <ExpYear>String</ExpYear>
  <JsonResponse>String</JsonResponse>
  <LastPayment>0001-01-01T00:00:00</LastPayment>
  <Mode>String</Mode>
  <MonthlyPrice>0</MonthlyPrice>
  <NextPayment>0001-01-01T00:00:00</NextPayment>
  <OwnerCardTypeId>0</OwnerCardTypeId>
  <OwnerId>0</OwnerId>
  <PanLastFour>String</PanLastFour>
  <PaymentTokenId>String</PaymentTokenId>
  <PhoneVerificationNumber>String</PhoneVerificationNumber>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <SubscriptionLength>0</SubscriptionLength>
  <TermsAcceptedAt>0001-01-01T00:00:00</TermsAcceptedAt>
  <TermsVersion>String</TermsVersion>
  <Token>String</Token>
  <TransactionFee>0</TransactionFee>
</RecurringPaymentCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringPaymentGetResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AlreadyExisted>false</AlreadyExisted>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:ChargeFirstMonth>false</d2p1:ChargeFirstMonth>
    <d2p1:Currency>String</d2p1:Currency>
    <d2p1:DeclinedCounter>0</d2p1:DeclinedCounter>
    <d2p1:DeviceId>String</d2p1:DeviceId>
    <d2p1:ExpMonth>String</d2p1:ExpMonth>
    <d2p1:ExpYear>String</d2p1:ExpYear>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:JsonResponse>String</d2p1:JsonResponse>
    <d2p1:LastDeclineDate>0001-01-01T00:00:00</d2p1:LastDeclineDate>
    <d2p1:LastDeclineReason>String</d2p1:LastDeclineReason>
    <d2p1:LastDunningNotifiedAt>0001-01-01T00:00:00</d2p1:LastDunningNotifiedAt>
    <d2p1:LastDunningStage>0</d2p1:LastDunningStage>
    <d2p1:LastPayment>0001-01-01T00:00:00</d2p1:LastPayment>
    <d2p1:Mode>String</d2p1:Mode>
    <d2p1:MonthlyPrice>0</d2p1:MonthlyPrice>
    <d2p1:MonthsPaid>0</d2p1:MonthsPaid>
    <d2p1:NextPayment>0001-01-01T00:00:00</d2p1:NextPayment>
    <d2p1:OwnerCardTypeId>0</d2p1:OwnerCardTypeId>
    <d2p1:OwnerId>0</d2p1:OwnerId>
    <d2p1:PanLastFour>String</d2p1:PanLastFour>
    <d2p1:PaymentTokenId>String</d2p1:PaymentTokenId>
    <d2p1:PhoneVerificationNumber>String</d2p1:PhoneVerificationNumber>
    <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:SubscriptionLength>0</d2p1:SubscriptionLength>
    <d2p1:TermsAcceptedAt>0001-01-01T00:00:00</d2p1:TermsAcceptedAt>
    <d2p1:TermsVersion>String</d2p1:TermsVersion>
    <d2p1:Token>String</d2p1:Token>
    <d2p1:TransactionFee>0</d2p1:TransactionFee>
  </Item>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</RecurringPaymentGetResult>