PaymentMethodTokenizationResponse Class

Namespace

CommercePayments

Usage

Example

This constructor builds a new instance of the PaymentMethodTokenizationResponse class.

commercepayments.PaymentMethodTokenizationResponse tokenizeResponse = new commercepayments.PaymentMethodTokenizationResponse();

PaymentMethodTokenizationResponse contains only setter methods. Each setter accepts a value from the payment gateway and use it to set an attribute of PaymentMethodTokenizationResponse.

The most important method in PaymentMethodTokenizationResponse is setGatewayTokenEncrypted, which uses Salesforce encryption to set an encrypted token value for a payment method. The setGatewayTokenEncrypted method is available in Salesforce API v52.0 and later. We recommend using it to ensure your tokenized payment method values are encrypted and secure. While the setGatewayToken method (available in earlier API versions) also returns a payment method token, the tokenized value isn't encrypted.

If the instantiated class already has a gateway token, setGatewayTokenEncrypted throws an error.

/** @description Method to set Gateway token to persist in Encrypted Text */
     global void setGatewayTokenEncrypted(String gatewayTokenEncrypted) {
         if (gatewayTokenSet)  {
             throwTokenError();
         }
         this.delegate.setGatewayTokenEncrypted(gatewayTokenEncrypted);
         gatewayTokenEncryptedSet = true;
     }

public commercepayments.GatewayResponse createTokenizeResponse(commercepayments.PaymentMethodTokenizationRequest tokenizeRequest) {
         commercepayments.PaymentMethodTokenizationResponse tokenizeResponse = new commercepayments.PaymentMethodTokenizationResponse();
         tokenizeResponse.setGatewayTokenEncrypted(gatewayTokenEncrypted);
         tokenizeResponse.setGatewayTokenDetails(gatewayTokenDetails);
         tokenizeResponse.setGatewayAvsCode(gatewayAvsCode);
         tokenizeResponse.setGatewayMessage(gatewayMessage);
         tokenizeResponse.setGatewayResultCode(gatewayResultCode);
         tokenizeResponse.setGatewayResultCodeDescription(gatewayResultCodeDescription);
         tokenizeResponse.setSalesforceResultCodeInfo(SUCCESS_SALESFORCE_RESULT_CODE_INFO);
         tokenizeResponse.setGatewayDate(system.now());
         return tokenizeResponse;
     }

After you've built a PaymentMethodTokenizationResponse object and set the encrypted gateway token, pass the object to the setPaymentMethodTokenizationResponse method of an authorization response or a sale response.

Authorization Response

public commercepayments.GatewayResponse createAuthResponse(commercepayments.AuthorizationRequest authRequest) {
         commercepayments.AuthorizationResponse authResponse = new commercepayments.AuthorizationResponse();
         commercepayments.PaymentMethodTokenizationResponse paymentMethodTokenizationResponse = new commercepayments.PaymentMethodTokenizationResponse();
         if(authRequest.amount!=null )
         {
             authResponse.setAmount(authRequest.amount);
         }
         else
         {
             throw new SalesforceValidationException('Required Field Missing : Amount');
         }
 
         authResponse.setGatewayResultCode('00');
         authResponse.setGatewayResultCodeDescription('Transaction Normal');
         authResponse.setGatewayAuthCode('SF'+getRandomNumber(6));
         authResponse.setGatewayReferenceNumber(getRandomNumber(10));
         authResponse.setSalesforceResultCodeInfo(SUCCESS_SALESFORCE_RESULT_CODE_INFO);
         authResponse.setGatewayDate(system.now());
         paymentMethodTokenizationResponse.setGatewayTokenEncrypted(gatewayTokenEncrypted);
         authResponse.setPaymentMethodTokenizationResponse(paymentMethodTokenizationResponse);
         return authResponse;
     }

Sale Response

public commercepayments.GatewayResponse createSaleResponse(commercepayments.SaleRequest saleRequest) {
         commercepayments.SaleResponse saleResponse = new commercepayments.SaleResponse();
         commercepayments.PaymentMethodTokenizationResponse paymentMethodTokenizationResponse = new commercepayments.PaymentMethodTokenizationResponse();
         if(saleRequest.amount!=null )
         {
             saleResponse.setAmount(saleRequest.amount);
         }
         else
         {
              throw new SalesforceValidationException('Required Field Missing : Amount');
         }
 
         system.debug('Response - success');
         saleResponse.setGatewayDate(system.now());
         saleResponse.setGatewayResultCode('00');
         saleResponse.setGatewayResultCodeDescription('Transaction Normal');
         saleResponse.setGatewayReferenceNumber('SF'+getRandomNumber(6));
         saleResponse.setSalesforceResultCodeInfo(SUCCESS_SALESFORCE_RESULT_CODE_INFO);
         paymentMethodTokenizationResponse.setGatewayTokenEncrypted(gatewayTokenEncrypted);
         saleResponse.setPaymentMethodTokenizationResponse(paymentMethodTokenizationResponse);
         return saleResponse;
     }