ClubReady Api

PaymentProfileImportEndpoint

The following routes are available for this service:
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.

**PaymentProfileImportEndpoint** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Authentication Key
AcctToken	body	string	Yes	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.
ProfileToken	body	string	Yes	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 time validation is to prevent old tokens from be re-played at a later time. The length is variable, but generally around 1,000 characters.
DoNotUpdatePaymentTypePreference	body	bool	No	When adding a Payment Profile that is 'on-file', the default behavior is to update the user's Payment Type Preference 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.
NewOwnerId	body	int?	No	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`.

**PaymentProfileImportRequest** Parameters:
Name	Parameter	Data Type	Required
AcctToken	form	string	No
ProfileToken	form	string	No
DoNotUpdatePaymentTypePreference	form	bool	No
NewOwner	form	ValueTuple<Int32,OwnerType>?	No

**PaymentProfileImportResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
PaymentProfile	form	PaymentProfile	No

**PaymentProfile** Parameters:
Name	Parameter	Data Type	Required
PaymentProfileId	form	int	No
AcctToken	form	string	No
OwnerId	form	int	No
OwnerTypeId	form	short	No
AcctTypeId	form	short	No
AcctClassId	form	short	No
PrefixName	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
SuffixName	form	string	No
Address1	form	string	No
Address2	form	string	No
Urbanization	form	string	No
City	form	string	No
State	form	string	No
PostalCode	form	string	No
CountryCode	form	string	No
Last4	form	string	No
CcExpMonth	form	byte?	No
CcExpYear	form	byte?	No
IsTemp	form	bool	No
IsDisabled	form	bool	No
OnHoldUtc	form	DateTime?	No
OnHoldReasonCode	form	byte?	No
OnHoldReasonDetail	form	string	No
AcctUpdaterFlagUtc	form	DateTime?	No
CreatedBy	form	int	No
CreatedUtc	form	DateTime	No
ModifiedBy	form	int	No
ModifiedUtc	form	DateTime	No
AcctUpdaterFlag	form	bool	No
EntryModeId	form	short	No
ExcludeFromAcctUpdater	form	bool	No

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 /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">
  <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>