ClubReady Api

<back to all web services


The following routes are available for this service:
POST/sales/paymentprofile/importImport 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:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Authentication Key
AcctTokenbodystringYes 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.
ProfileTokenbodystringYes 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.
DoNotUpdatePaymentTypePreferencebodyboolNo 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.
NewOwnerIdbodyint?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:
NameParameterData TypeRequiredDescription
PaymentProfileImportResponse Parameters:
NameParameterData TypeRequiredDescription

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv


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 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApiKey":"String","AcctToken":"String","ProfileToken":"String","DoNotUpdatePaymentTypePreference":false,"NewOwnerId":0,"NewOwner":"(0, Unknown)"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length