Skip to main content

Payment Services

Payment Services is TokenEx's standardized integration layer for payment processing. Instead of building direct integrations with each payment processor, you integrate once with Payment Services and gain access to a wide range of gateways through a consistent API. Switch processors or add new ones without changing your integration code—just update the gateway configuration in your requests.

Key benefits:

  • Gateway flexibility — Connect to multiple processors through a single integration
  • Token portability — Use the same TokenEx tokens across any supported gateway
  • Reduced PCI scope — Keep PANs out of your environment by transacting with tokens
  • Combined operations — Tokenize and transact in a single API call when needed
  • CVV injection — Include separately collected CVV values without handling them directly

How Does Payment Services Work?

Payment Services processes transactions through the following flow:

  1. Collect payment data — Use TokenEx iFrame, mobile SDK, or your existing collection method to capture card details
  2. Send the transaction — Call Payment Services with your token, encrypted or plaintext PAN, and the transaction request fields.
  3. Receive the response — Payment Services returns the transaction result with parsed fields from the PSP

Choosing Your API

Payment Services offers two APIs. For most integrations, we recommend the ProcessTransaction API.

The ProcessTransaction API provides the broadest gateway support and a normalized response format that simplifies your integration logic.

Key advantages:

  • Extensive gateway coverage — Connect to a wide range of payment processors
  • Normalized responses — Consistent response structure with pre-parsed AVS and CVV results
  • Flexible tokenization — Use existing tokens or tokenize during the transaction
  • CVV injection — Include previously collected CVV values
  • Two endpoints for different workflows:
    • ProcessTransaction — Use your existing TokenEx tokens
    • ProcessTransactionAndTokenize — Accept PANs or encrypted PANs and tokenize during the transaction
When to use ProcessTransaction API

Choose this API when you need broad gateway coverage, want consistent response handling across processors, and don't require access to the PSP's raw response.

Card/Check/Wallet API

The Card/Check/Wallet API returns complete, unmodified gateway responses for integrations that need access to every field the processor returns.

Key advantages:

  • Raw gateway responses — Access the complete, unmodified response from the processor
  • REST-style endpoints — Resource-oriented paths like /card/authorize and /check/purchase
  • Response extraction — Use regex patterns to extract specific fields from the raw PSP response into standardized response parameters.
  • Parameter forwarding — send unmapped parameters to PSPs that accept JSON request bodies
When to use Card/Check/Wallet API

Choose this API when you need access to the complete gateway response, require specific response fields that aren't included in normalized responses, or have existing logic built around raw gateway data.

Feature Comparison

FeatureProcessTransaction APICard/Check/Wallet API
Gateway CoverageBroad gateway supportSelected gateway support
Endpoint StyleAction-based (ProcessTransaction, ProcessTransactionAndTokenize)Resource-oriented (/card/authorize, /check/purchase)
AuthenticationRequest body credentials (APIKey, TokenExID)HTTP headers
Response FormatNormalized with parsed AVS/CVVRaw gateway response
Transaction TypesAuthorize, Capture, Purchase, Refund, Void, ReverseAuthorize, Capture, Purchase, Refund, Void
Encrypted PAN InputSupported via ProcessTransactionAndTokenizeNot supported
CVV InjectionSupportedSupported
Custom Parameter ForwardingNot SupportedSelected PSP integrations not built on SDKs and accept JSON requests
Response Extraction (Regex)Not ApplicableSupported

Prerequisites

Before integrating Payment Services, ensure you have:

  1. TokenEx account — Contact IXOPAY to set up your account
  2. API credentials — Your TokenExID and APIKey for authentication
  3. Gateway credentials — Merchant credentials for your chosen payment processors
Getting started

If you don't have TokenEx Vault credentials, visit the Client Portal or contact your IXOPAY representative.

ProcessTransaction API

  • The Basics — Endpoints, transaction types, and request/response structure
  • Gateway Parameters — Configuration for each supported gateway

Card/Check/Wallet API