Payment Services - The Basics

Payment Services provides an abstraction layer between you and various Payment Service Providers and allows you to facilitate payment processing without your application obtaining the PAN.

🚧

HEADS-UP!

Payment Services v1 has been deprecated and is now in break/fix mode. All new enhancements are being added to Payment Services v2.

Process Transaction

The ProcessTransaction method allows you to conduct a transaction with a supported payment gateway or processor using your token. This method facilitates Authorization, Capture, Purchase, Refund, and Void transactions. The specific input parameters to be included with this request are dependent upon the payment gateway or processor you are using. If a field is not required for your gateway, it does not have to be populated.

ProcessTransaction must be invoked by making an HTTPS POST to the ProcessTransaction endpoint.

The complete list of currently-supported gateways, and details of input parameters for each of those gateways, can be found in [Gateway Parameters][gp].

(Optional) To inject a CVV that was previously collected by TokenEx, set the value of the gateway specific CVV parameter equal to "cvv". Payment Services will replace that value with the CVV value linked to the token.

URI: https://test-api.tokenex.com/PaymentServices.svc/REST/ProcessTransaction

Request Parameters : TokenEx-Specific Parameters

ParameterTypeDescription
APIKeystring
TokenExIDstringYour TokenEx ID
TransactionTypestringThe type of transaction you wish to conduct. This is where you will stipulate Authorize (1), Capture (2), Purchase (3), Refund (4), Void (5), Reverse (6).

Request Parameters : Gateway Parameters

To obtain the list of supported parameters for supported payment service providers, please contact Technical Support via the Client Portal.

Response Parameters

ParameterType
Successbool
ReferenceNumberstring
Errorstring
Authorizationstring
Messagestring
AVS_Resultstring
CVV_Resultstring
Paramsstring
TransactionResultbool
{
	"Error": "",
	"ReferenceNumber": "15102913382030662954",
	"Success": true,
	"AVS_Result": {
		"Code": "String content",
		"Message": "String content",
		"PostalMatch": "String content",
		"StreetMatch": "String content"
	},
	"Authorization": "123456;A",
	"CVV_Result": {
		"Code": "String content",
		"Message": "String content"
	},
	"Message": "Transaction Approved",
	"Params": [{
		"Key": "AuthorizationCode",
		"Value": "A"
	}, {
		"Key": "TransactionID",
		"Value": "123456"
	}],
	"Test": true,
	"TransactionResult": true
}

Process Transaction and Tokenize

The ProcessTransactionAndTokenize method allows you to conduct a transaction with a supported payment gateway or processor using a PAN or encrypted PAN. This process will also tokenize the PAN. This method facilitates Authorization, Capture, Purchase, Refund, and Void transactions. The specific input parameters to be included with this request are dependent upon the payment gateway or processor you are using. If a field is not required for your gateway, it does not have to be populated.

ProcessTransactionAndTokenize must be invoked by making an HTTPS POST to the ProcessTransactionAndTokenize endpoint.

The complete list of currently-supported gateways, and details of input parameters for each of those gateways, can be found in [Gateway Parameters][gp].

URI: https://test-api.tokenex.com/PaymentServices.svc/REST/ProcessTransactionAndTokenize

Request Parameters : TokenEx-Specific Parameters

ParameterType
APIKeystring
TokenExIDstring
TransactionTypestring
Encryptedbool
TokenSchemeEnum

Request Parameters : Gateway Parameters

To obtain the list of supported fields for your Payment Service Provider, please see the [Gateway Parameters][gp] section.

Response Parameters

ParameterType
Successbool
ReferenceNumberstring
Errorstring
Authorizationstring
Messagestring
AVS_Resultstring
CVV_Resultstring
Paramsstring
Tokenstring
TransactionResultbool
{
	"Error": "",
	"ReferenceNumber": "15102913382030662954",
	"Success": true,
	"AVS_Result": {
		"Code": "String content",
		"Message": "String content",
		"PostalMatch": "String content",
		"StreetMatch": "String content"
	},
	"Authorization": "123456;A",
	"CVV_Result": {
		"Code": "String content",
		"Message": "String content"
	},
	"Message": "Transaction Approved",
	"Params": [{
		"Key": "AuthorizationCode",
		"Value": "A"
	}, {
		"Key": "TransactionID",
		"Value": "123456"
	}],
	"Test": true,
	"Token":"545454587415454",
	"TransactionResult": true
}