| POST | /sales/member/{MemberId}/payment/profile | Add Payment Profile for a Member |
|---|
| Name | Parameter | Data Type | Required | Description | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ApiKey | query | string | Yes | Api Authentication Key | |||||||||||||||||||||||||||
| StoreId | query | int? | Yes | Id of the store for the user | |||||||||||||||||||||||||||
| MemberId | path | int | Yes | Member Id of the user to update their Payment Profile | |||||||||||||||||||||||||||
| AcctToken | body | string | Yes | The AcctToken provided by creating a Payment Profile with the Vault Api | |||||||||||||||||||||||||||
| Last4 | body | string | No | Last 4 digits of the Payment Profile | |||||||||||||||||||||||||||
| ExpMonth | body | int? | No | 2 digit expiration month
**Required for Credit Card**Valid Range: 1 - 12 | |||||||||||||||||||||||||||
| ExpYear | body | int? | No | 2 digit expiration year
**Required for Credit Card**Valid Range: 10 - 99 | |||||||||||||||||||||||||||
| AcctType | body | AcctType? | No |
The Account Type of the Payment Profile
**Required when adding Gift Card**
Common Values
You may use the Text or the Numerical value. Allowable Values
| |||||||||||||||||||||||||||
| BnkRoute | body | int? | No | Bank Routing Number
**Required for Bank Accounts**Valid Range: 0 - 999999999 | |||||||||||||||||||||||||||
| DoNotUpdatePaymentTypePreference | body | bool | No | Set to `true` to not set the user's Payment Type Preference when adding an on-file profile | |||||||||||||||||||||||||||
| IsTemp | body | bool | No | Whether the Payment Profile is Temporary (One time transactions and Gift Cards are IsTemp = `true`) | |||||||||||||||||||||||||||
| RestrictedId | body | int? | No | ||||||||||||||||||||||||||||
| RestrictedResourceType | body | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | int | No | |
| AcctToken | form | string | No | |
| Last4 | form | string | No | |
| ExpMonth | form | int? | No | |
| ExpYear | form | int? | No | |
| AcctType | form | AcctType? | No | |
| BnkRoute | form | int? | No | |
| FirstName | form | string | No | |
| MiddleName | form | string | No | |
| LastName | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| PostalCode | form | string | No | |
| CountryCode | form | string | No | |
| Urbanization | form | string | No | |
| DoNotUpdatePaymentTypePreference | form | bool | No | |
| IsTemp | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No |
| Name | Value | |
|---|---|---|
| Uninitialized | 0 | Uninitialized |
| Visa | 1 | VISA |
| MC | 2 | MasterCard |
| Disc | 3 | Discover |
| Amex | 4 | American Express |
| Diners | 5 | Diners |
| JCB | 6 | JCB |
| enRoute | 7 | enRoute |
| PayPal | 8 | PayPal |
| BillMe | 9 | Bill Me Later |
| PC | 11 | Personal Checking |
| PS | 12 | Personal Savings |
| BC | 13 | Business Checking |
| BS | 14 | Business Savings |
| Becs | 15 | BECS Direct Debit |
| Bacs | 16 | BACS Direct Debit |
| Maestro | 20 | Maestro |
| Solo | 21 | Solo |
| VisaElectron | 22 | Visa Electron |
| CIBC | 23 | CIBC Convenience Card |
| RoyalBankCa | 24 | Royal Bank of Canada Client |
| TDCaTrust | 25 | TD Canada Trust Access Card |
| Scotia | 26 | Scotiabank Scotia Card |
| BMO | 27 | BMO ABM Card |
| HSBCCa | 28 | HSBC Canada Card |
| UnionPay | 29 | China UnionPay |
| InterPayment | 30 | InterPayment |
| Laser | 31 | Laser |
| UnknownCredit | 40 | Unknown Credit Card |
| TransArmor | 41 | TransArmor |
| Factor4 | 42 | Factor4 |
| XPass | 43 | XPass |
| ConnectedAccount | 44 | Connected Account |
| UnknownBank | 45 | Unknown Bank Account |
| Error | -1 | Error |
| Store | |
| Chain | |
| User | |
| Undefined |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | string | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sales/member/{MemberId}/payment/profile HTTP/1.1
Host: clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
StoreId: 0,
MemberId: 0,
AcctToken: String,
AuthToken: String,
Last4: String,
ExpMonth: 0,
ExpYear: 0,
AcctType: Uninitialized,
CardType: 0,
BnkRoute: 0,
DoNotUpdatePaymentTypePreference: False,
IsTemp: False,
RestrictedId: 0,
RestrictedResourceType: Chain,
UserId: 0,
FirstName: String,
MiddleName: String,
LastName: String,
Address1: String,
Address2: String,
City: String,
State: String,
PostalCode: String,
CountryCode: String,
Urbanization: String,
ChainId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: String,
Message: String
}