| POST | /sales/paymentprofile/import | Import a Payment Profile (using ProfileToken) | After a Payment Profile is created in the ClubReadyGateway API (aka Vault API), the information has to be imported into the ClubReady system. The AcctToken and ProfileToken are created by the ClubReadyGateway API. |
|---|
import 'package:servicestack/servicestack.dart';
class PaymentProfileImportRequest implements IConvertible
{
String? AcctToken;
String? ProfileToken;
bool? DoNotUpdatePaymentTypePreference;
ValueTuple<int,OwnerType>? NewOwner;
PaymentProfileImportRequest({this.AcctToken,this.ProfileToken,this.DoNotUpdatePaymentTypePreference,this.NewOwner});
PaymentProfileImportRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AcctToken = json['AcctToken'];
ProfileToken = json['ProfileToken'];
DoNotUpdatePaymentTypePreference = json['DoNotUpdatePaymentTypePreference'];
NewOwner = JsonConverters.fromJson(json['NewOwner'],'ValueTuple<int,OwnerType>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'AcctToken': AcctToken,
'ProfileToken': ProfileToken,
'DoNotUpdatePaymentTypePreference': DoNotUpdatePaymentTypePreference,
'NewOwner': JsonConverters.toJson(NewOwner,'ValueTuple<int,OwnerType>',context!)
};
getTypeName() => "PaymentProfileImportRequest";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="", ResponseType=typeof(PaymentProfileImportResponse), StatusCode=200)
class PaymentProfileImportEndpoint extends PaymentProfileImportRequest implements IApiKeyEndpoint, IConvertible
{
/**
* Api Authentication Key
*/
// @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
String? ApiKey;
/**
* 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)
String? AcctToken;
/**
* 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.", IsRequired=true)
String? ProfileToken;
/**
* When adding a Payment Profile that is 'on-file', the default behavior is to update the user's Payment TypePreference to the AcctClass of the new profile. If you wish to not update the preference, you can set`DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can be omitted or `false`. For `IsTemp == true` profiles, `DoNotUpdatePaymentTypePreference` is ignored.
*/
// @ApiMember(Description="\r\nWhen adding a Payment Profile that is 'on-file', the default behavior is to update the user's Payment Type\r\nPreference to the AcctClass of the new profile. If you wish to not update the preference, you can set\r\n`DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can be omitted or `false`. \r\n\r\nFor `IsTemp == true` profiles, `DoNotUpdatePaymentTypePreference` is ignored.")
bool? DoNotUpdatePaymentTypePreference;
/**
* **Conditionally Required** When adding a Payment Profile that has an OwnerType of `TempStUser`, the ownership will be changed to OwnerType of `User`with the `UserId` of the supplied `NewOwnerId`.
*/
// @ApiMember(Description="\r\n**Conditionally Required** \r\n\r\nWhen adding a Payment Profile that has an OwnerType of `TempStUser`, the ownership will be changed to OwnerType of `User`\r\nwith the `UserId` of the supplied `NewOwnerId`.")
int? NewOwnerId;
PaymentProfileImportEndpoint({this.ApiKey,this.AcctToken,this.ProfileToken,this.DoNotUpdatePaymentTypePreference,this.NewOwnerId});
PaymentProfileImportEndpoint.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ApiKey = json['ApiKey'];
AcctToken = json['AcctToken'];
ProfileToken = json['ProfileToken'];
DoNotUpdatePaymentTypePreference = json['DoNotUpdatePaymentTypePreference'];
NewOwnerId = json['NewOwnerId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ApiKey': ApiKey,
'AcctToken': AcctToken,
'ProfileToken': ProfileToken,
'DoNotUpdatePaymentTypePreference': DoNotUpdatePaymentTypePreference,
'NewOwnerId': NewOwnerId
});
getTypeName() => "PaymentProfileImportEndpoint";
TypeContext? context = _ctx;
}
class PaymentProfile implements IConvertible
{
int? PaymentProfileId;
String? AcctToken;
int? OwnerId;
int? OwnerTypeId;
int? AcctTypeId;
int? AcctClassId;
String? 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;
int? CcExpMonth;
int? CcExpYear;
bool? IsTemp;
bool? IsDisabled;
DateTime? OnHoldUtc;
int? OnHoldReasonCode;
String? OnHoldReasonDetail;
DateTime? AcctUpdaterFlagUtc;
int? CreatedBy;
DateTime? CreatedUtc;
int? ModifiedBy;
DateTime? ModifiedUtc;
bool? AcctUpdaterFlag;
int? EntryModeId;
bool? ExcludeFromAcctUpdater;
PaymentProfile({this.PaymentProfileId,this.AcctToken,this.OwnerId,this.OwnerTypeId,this.AcctTypeId,this.AcctClassId,this.PrefixName,this.FirstName,this.MiddleName,this.LastName,this.SuffixName,this.Address1,this.Address2,this.Urbanization,this.City,this.State,this.PostalCode,this.CountryCode,this.Last4,this.CcExpMonth,this.CcExpYear,this.IsTemp,this.IsDisabled,this.OnHoldUtc,this.OnHoldReasonCode,this.OnHoldReasonDetail,this.AcctUpdaterFlagUtc,this.CreatedBy,this.CreatedUtc,this.ModifiedBy,this.ModifiedUtc,this.AcctUpdaterFlag,this.EntryModeId,this.ExcludeFromAcctUpdater});
PaymentProfile.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
PaymentProfileId = json['PaymentProfileId'];
AcctToken = json['AcctToken'];
OwnerId = json['OwnerId'];
OwnerTypeId = json['OwnerTypeId'];
AcctTypeId = json['AcctTypeId'];
AcctClassId = json['AcctClassId'];
PrefixName = json['PrefixName'];
FirstName = json['FirstName'];
MiddleName = json['MiddleName'];
LastName = json['LastName'];
SuffixName = json['SuffixName'];
Address1 = json['Address1'];
Address2 = json['Address2'];
Urbanization = json['Urbanization'];
City = json['City'];
State = json['State'];
PostalCode = json['PostalCode'];
CountryCode = json['CountryCode'];
Last4 = json['Last4'];
CcExpMonth = json['CcExpMonth'];
CcExpYear = json['CcExpYear'];
IsTemp = json['IsTemp'];
IsDisabled = json['IsDisabled'];
OnHoldUtc = JsonConverters.fromJson(json['OnHoldUtc'],'DateTime',context!);
OnHoldReasonCode = json['OnHoldReasonCode'];
OnHoldReasonDetail = json['OnHoldReasonDetail'];
AcctUpdaterFlagUtc = JsonConverters.fromJson(json['AcctUpdaterFlagUtc'],'DateTime',context!);
CreatedBy = json['CreatedBy'];
CreatedUtc = JsonConverters.fromJson(json['CreatedUtc'],'DateTime',context!);
ModifiedBy = json['ModifiedBy'];
ModifiedUtc = JsonConverters.fromJson(json['ModifiedUtc'],'DateTime',context!);
AcctUpdaterFlag = json['AcctUpdaterFlag'];
EntryModeId = json['EntryModeId'];
ExcludeFromAcctUpdater = json['ExcludeFromAcctUpdater'];
return this;
}
Map<String, dynamic> toJson() => {
'PaymentProfileId': PaymentProfileId,
'AcctToken': AcctToken,
'OwnerId': OwnerId,
'OwnerTypeId': OwnerTypeId,
'AcctTypeId': AcctTypeId,
'AcctClassId': AcctClassId,
'PrefixName': PrefixName,
'FirstName': FirstName,
'MiddleName': MiddleName,
'LastName': LastName,
'SuffixName': SuffixName,
'Address1': Address1,
'Address2': Address2,
'Urbanization': Urbanization,
'City': City,
'State': State,
'PostalCode': PostalCode,
'CountryCode': CountryCode,
'Last4': Last4,
'CcExpMonth': CcExpMonth,
'CcExpYear': CcExpYear,
'IsTemp': IsTemp,
'IsDisabled': IsDisabled,
'OnHoldUtc': JsonConverters.toJson(OnHoldUtc,'DateTime',context!),
'OnHoldReasonCode': OnHoldReasonCode,
'OnHoldReasonDetail': OnHoldReasonDetail,
'AcctUpdaterFlagUtc': JsonConverters.toJson(AcctUpdaterFlagUtc,'DateTime',context!),
'CreatedBy': CreatedBy,
'CreatedUtc': JsonConverters.toJson(CreatedUtc,'DateTime',context!),
'ModifiedBy': ModifiedBy,
'ModifiedUtc': JsonConverters.toJson(ModifiedUtc,'DateTime',context!),
'AcctUpdaterFlag': AcctUpdaterFlag,
'EntryModeId': EntryModeId,
'ExcludeFromAcctUpdater': ExcludeFromAcctUpdater
};
getTypeName() => "PaymentProfile";
TypeContext? context = _ctx;
}
class PaymentProfileImportResponse implements IConvertible
{
bool? Success;
String? Message;
PaymentProfile? PaymentProfile;
PaymentProfileImportResponse({this.Success,this.Message,this.PaymentProfile});
PaymentProfileImportResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Success = json['Success'];
Message = json['Message'];
PaymentProfile = JsonConverters.fromJson(json['PaymentProfile'],'PaymentProfile',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Success': Success,
'Message': Message,
'PaymentProfile': JsonConverters.toJson(PaymentProfile,'PaymentProfile',context!)
};
getTypeName() => "PaymentProfileImportResponse";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'clubready.com', types: <String, TypeInfo> {
'PaymentProfileImportRequest': TypeInfo(TypeOf.Class, create:() => PaymentProfileImportRequest()),
'ValueTuple<int,OwnerType>': TypeInfo(TypeOf.Class, create:() => ValueTuple<int,OwnerType>()),
'OwnerType': TypeInfo(TypeOf.Class, create:() => OwnerType()),
'PaymentProfileImportEndpoint': TypeInfo(TypeOf.Class, create:() => PaymentProfileImportEndpoint()),
'PaymentProfile': TypeInfo(TypeOf.Class, create:() => PaymentProfile()),
'PaymentProfileImportResponse': TypeInfo(TypeOf.Class, create:() => PaymentProfileImportResponse()),
});
Dart PaymentProfileImportEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/paymentprofile/import HTTP/1.1
Host: 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">
<AcctToken xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">String</AcctToken>
<DoNotUpdatePaymentTypePreference xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">false</DoNotUpdatePaymentTypePreference>
<NewOwner xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">
<d2p1:Item1>0</d2p1:Item1>
<d2p1:Item2>Unknown</d2p1:Item2>
</NewOwner>
<ProfileToken xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Payments">String</ProfileToken>
<ApiKey>String</ApiKey>
<NewOwnerId>0</NewOwnerId>
</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>