TicketUserServices

<back to all web services

RecurringPaymentListRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdmin
The following routes are available for this service:
GET/recurringPayments
import Foundation
import ServiceStack

public class RecurringPaymentListRequest : Codable
{
    public var ownerId:Int?
    public var status:String?
    public var phoneVerificationNumber:String?
    public var limit:Int?

    required public init(){}
}

public class RecurringPaymentListResult : Codable
{
    public var items:[RecurringPayment] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class RecurringPayment : Codable
{
    public var id:Int?
    public var status:String?
    public var phoneVerificationNumber:String?
    public var deviceId:String?
    public var panLastFour:String?
    public var expYear:String?
    public var expMonth:String?
    public var token:String?
    public var monthlyPrice:Int?
    public var subscriptionLength:Int?
    public var monthsPaid:Int?
    public var chargeFirstMonth:Bool?
    // @References(typeof(EventOwner))
    public var ownerId:Int?

    public var ownerCardTypeId:Int?
    // @StringLength(Int32.max)
    public var jsonResponse:String?

    public var startDate:Date?
    public var lastPayment:Date?
    public var nextPayment:Date?
    public var paymentTokenId:String?
    public var declinedCounter:Int?
    public var transactionFee:Double?
    public var termsVersion:String?
    public var termsAcceptedAt:Date?
    public var currency:String?
    public var mode:String?
    public var lastDeclineReason:String?
    public var lastDeclineDate:Date?
    public var lastDunningStage:UInt8?
    public var lastDunningNotifiedAt:Date?

    required public init(){}
}


Swift RecurringPaymentListRequest 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.

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

<RecurringPaymentListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types.Payouts">
    <d2p1:RecurringPayment>
      <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>
    </d2p1:RecurringPayment>
  </Items>
  <Message>String</Message>
  <StatusCode>0</StatusCode>
</RecurringPaymentListResult>