Submit Documentation FeedbackJoin Developer CommunityLog In

TokenEx API call

This topic provides an overview of TokenEx API responses.

We use TokenEx (https://tokenex.com/) as a common payment gateway provider for our Cloud offering for a variety of reasons including improved security, and simpler PCI compliance. To use this provider, all Cloud customers must implement an iframe to capture the credit card number and CVV. Our implementation also has some credit card formatting as the card number is entered. See iFramed credit card processing for Cloud.

TokenEx API Endpoint

Whenever we use TokenEx to pass in a credit card, we need to obtain a temporary authentication key, which is good for 30 minutes. The API endpoint to retrieve this key is called /api/v1/tokenexconfig and supports the GET function. The call doesn't need any parameters and is not overridable, as there is not a handler involved. (To test, just provide the authorization bearer token to view the response. See Admin API architecture.

The API response includes the following:

OriginPrimary website URL.
TimestampYear, month, day and time of request.
TokenEx IDThe value entered in this field under the Use TokenEx Gateway setting.
Token SchemeThe value entered in this field under the Use TokenEx Gateway setting.
AuthenticationKeyEncoded value that expires after 30 minutes.

TokenEx API Response Example

Did this page help you?