ClubReady Api

<back to all web services

PaymentProfileImportEndpoint

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Sales;
using ClubReady.Payments;
using ClubReady.Payments.PaymentsDb;

namespace ClubReady.Payments
{
    public partial class PaymentProfileImportRequest
    {
        public virtual string ProfileToken { get; set; }
        public virtual bool DoNotUpdatePaymentTypePreference { get; set; }
        public virtual int? NewOwnerId { get; set; }
    }

    public partial class PaymentProfileImportResponse
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual PaymentProfile PaymentProfile { get; set; }
    }

}

namespace ClubReady.Payments.PaymentsDb
{
    public partial class PaymentProfile
        : IFullNameContainer
    {
        public virtual int PaymentProfileId { get; set; }
        public virtual string AcctToken { get; set; }
        public virtual int OwnerId { get; set; }
        public virtual short OwnerTypeId { get; set; }
        public virtual short AcctTypeId { get; set; }
        public virtual short AcctClassId { get; set; }
        public virtual string PrefixName { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string SuffixName { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string Urbanization { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string CountryCode { get; set; }
        public virtual string Last4 { get; set; }
        public virtual byte? CcExpMonth { get; set; }
        public virtual byte? CcExpYear { get; set; }
        public virtual bool IsTemp { get; set; }
        public virtual bool IsDisabled { get; set; }
        public virtual DateTime? OnHoldUtc { get; set; }
        public virtual byte? OnHoldReasonCode { get; set; }
        public virtual string OnHoldReasonDetail { get; set; }
        public virtual DateTime? AcctUpdaterFlagUtc { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual DateTime CreatedUtc { get; set; }
        public virtual int ModifiedBy { get; set; }
        public virtual DateTime ModifiedUtc { get; set; }
        public virtual bool AcctUpdaterFlag { get; set; }
        public virtual short EntryModeId { get; set; }
        public virtual bool ExcludeFromAcctUpdater { get; set; }
    }

}

namespace ClubReady.Web.Api.Sales
{
    [ApiResponse(Description="", ResponseType=typeof(ClubReady.Payments.PaymentProfileImportResponse), StatusCode=200)]
    public partial class PaymentProfileImportEndpoint
        : PaymentProfileImportRequest, IApiKeyEndpoint
    {
        ///<summary>
        ///IP address of the end user
        ///</summary>
        [ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")]
        public virtual string XForwardedFor { get; set; }

        ///<summary>
        ///API Authentication Key
        ///</summary>
        [ApiMember(Description="API Authentication Key", IsRequired=true, ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///The ProfileToken JWT to import (see description above)
        ///</summary>
        [ApiMember(Description="The ProfileToken JWT to import (see description above)", IsRequired=true)]
        public virtual string ProfileToken { get; set; }

        ///<summary>
        ///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.
        ///</summary>
        [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.")]
        public virtual bool DoNotUpdatePaymentTypePreference { get; set; }

        ///<summary>
        ///**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.
        ///</summary>
        [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.")]
        public virtual int? NewOwnerId { get; set; }
    }

}

C# PaymentProfileImportEndpoint DTOs

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

{
	XForwardedFor: String,
	ApiKey: String,
	ProfileToken: String,
	DoNotUpdatePaymentTypePreference: False,
	NewOwnerId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	PaymentProfile: 
	{
		PaymentProfileId: 0,
		AcctToken: String,
		OwnerId: 0,
		OwnerTypeId: 0,
		AcctTypeId: 0,
		AcctClassId: 0,
		PrefixName: String,
		FirstName: String,
		MiddleName: String,
		LastName: String,
		SuffixName: String,
		Address1: String,
		Address2: String,
		Urbanization: String,
		City: String,
		State: String,
		PostalCode: String,
		CountryCode: String,
		Last4: String,
		CcExpMonth: 0,
		CcExpYear: 0,
		IsTemp: False,
		IsDisabled: False,
		OnHoldUtc: 0001-01-01,
		OnHoldReasonCode: 0,
		OnHoldReasonDetail: String,
		AcctUpdaterFlagUtc: 0001-01-01,
		CreatedBy: 0,
		CreatedUtc: 0001-01-01,
		ModifiedBy: 0,
		ModifiedUtc: 0001-01-01,
		AcctUpdaterFlag: False,
		EntryModeId: 0,
		ExcludeFromAcctUpdater: False
	}
}