| GET | /sales/wallet/wallettokencreate | Creates a Wallet Token for a user |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| XForwardedFor | header | string | No | IP address of the end user |
| ApiKey | query | string | Yes | Api Key - grants access to resources |
| OwnerId | query | integer | Yes | ID # of the owner to create the URL for |
| OwnerType | query | OwnerType | Yes | Type of owner to create the URL forAllowable Values
|
| CreatorId | query | int | Yes | Person creating the profile. Can be same as OwnerId. |
| CreatorType | query | OwnerType | Yes | Wallet Token to use for the requestAllowable Values
|
| Page | query | WalletPage | Yes | Page to display when calling the Payment Profile iFrameAllowable Values
|
| Theme | query | string | No | CSS Theme |
| RestrictedId | query | int? | No | |
| RestrictedResourceType | query | RestrictedResourceType | No | |
| AllowDeleteProfile | query | bool? | No | Allows for a payment profile to be deleted |
| AllowDisableProfile | query | bool? | No | Allows for a payment profile to be disabled |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OwnerId | form | int | No | |
| OwnerType | form | OwnerType | No | |
| CreatorId | form | int | No | |
| CreatorType | form | OwnerType | No | |
| Page | form | WalletPage | No | |
| Theme | form | string | No | |
| AllowDeleteProfile | form | bool? | No | |
| AllowDisableProfile | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No |
| Name | Value | |
|---|---|---|
| Unknown | 0 | Unknown |
| User | 1 | User |
| ConvUser | 2 | Conversion User |
| TempCart | 3 | Temporary - ShoppingCart |
| TempAgmt | 4 | Temporary - IncompleteAgreement |
| Store | 5 | Store |
| Chain | 6 | Chain |
| Division | 7 | Division |
| District | 8 | District |
| AdminType | 9 | AdminType |
| TempStUser | 10 | TempStUser |
| VaultApi | 11 | VaultApi |
| Company | 12 | Company |
| BackOfficeStore | 13 | BackOfficeStore |
| OrgUser | 14 | OrgUser |
| CartItem | 15 | Cart Item |
| Testing | 99 | Test |
| System | 100 | System |
| Error | -1 | Error |
| Uninitialized | |
| Manage | |
| Add | |
| AddCard | |
| AddBank | |
| AddMini | |
| AddCardMini | |
| AddBankMini |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No | |
| WalletToken | form | string | No | |
| WalletOrigin | form | string | No | |
| WalletUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| WalletToken | form | string | No | |
| WalletOrigin | form | string | No | |
| WalletUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Message | form | string | No |
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.
GET /sales/wallet/wallettokencreate HTTP/1.1 Host: www.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>