ClubReady Api

<back to all web services

WalletTokenCreateEndpoint

The following routes are available for this service:
GET/sales/wallet/wallettokencreateCreates a Wallet Token for a user
WalletTokenCreateEndpoint Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
OwnerIdqueryintegerYesID # of the owner to create the URL for
OwnerTypequeryOwnerTypeYesType of owner to create the URL for

Allowable Values

  • User
CreatorIdqueryintYesPerson creating the profile. Can be same as OwnerId.
PagequeryWalletPageYesPage to display when calling the Payment Profile iFrame

Allowable Values

  • Manage
  • Add
  • AddCard
  • AddBank
ThemequerystringNoCSS Theme
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
AllowDeleteProfilequerybool?NoAllows for a payment profile to be deleted
AllowDisableProfilequerybool?NoAllows for a payment profile to be disabled
WalletTokenCreateRequestDto Parameters:
NameParameterData TypeRequiredDescription
OwnerIdformintNo
OwnerTypeformOwnerTypeNo
CreatorIdformintNo
PageformWalletPageNo
ThemeformstringNo
AllowDeleteProfileformbool?No
AllowDisableProfileformbool?No
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
OwnerType Enum:
NameValue
Unknown0Unknown
User1User
ConvUser2Conversion User
TempCart3Temporary - ShoppingCart
TempAgmt4Temporary - IncompleteAgreement
Store5Store
Chain6Chain
Division7Division
District8District
AdminType9AdminType
TempStUser10TempStUser
VaultApi11VaultApi
Company12Company
BackOfficeStore13BackOfficeStore
OrgUser14OrgUser
CartItem15Cart Item
Testing99Test
System100System
Error-1Error
WalletPage Enum:
Uninitialized
Manage
Add
AddCard
AddBank
AddMini
AddCardMini
AddBankMini
RestrictedResourceType Enum:
Store
Chain
User
Undefined
WalletTokenCreateResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
WalletTokenformstringNo
WalletOriginformstringNo
WalletUrlformstringNo
WalletTokenCreateResponseDto Parameters:
NameParameterData TypeRequiredDescription
WalletTokenformstringNo
WalletOriginformstringNo
WalletUrlformstringNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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 /sales/wallet/wallettokencreate HTTP/1.1 
Host: clubready.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WalletTokenCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Sales.Wallet">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <WalletOrigin xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</WalletOrigin>
  <WalletToken xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</WalletToken>
  <WalletUrl xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Sales.Wallet">String</WalletUrl>
</WalletTokenCreateResponse>