Menu

Note: This SDK is for preview purposes only and is subject to change.

CVC Validation

SDK v1
Coming soon

Validate your customer's cvc details before processing them.

Warning: The validation does not check if your customer's card details are correct. The validator only checks the formatting of the entered details.


Get started

To integrate the validation feature you must:

  • initialize the AccessCheckout client (you would already have an instance if you have implemented the Session feature)
  • create an implementation of a CvcOnlyValidationEventListener to be notified of validation events
  • get an instance of the function used to initialize the validation, using our useCvcOnlyValidation() hook
  • call that function once your UI components are present in the DOM in order to effectively initialize the validation

Full sample Integration: You can see an example of the cvc validation integrationhere.

Initialize the AccessCheckout client

First step to implement the validation is to create an instance of AccessCheckout, if you don't already have one.

To do this, you must provide your baseUrl and merchantId.

Here's an example of how to initialize it.

Copied!
import {
  AccessCheckout,
} from '@worldpay-beta/access-worldpay-checkout-react-native-sdk-beta';

const accessCheckout = new AccessCheckout({
  baseUrl: 'https://try.access.worldpay.com/',
  merchantId: 'YOUR_MERCHANT_ID',
});

Parameters

ParameterDescription
baseUrl
  • For testing use: https://try.access.worldpay.com/
  • For live use: https://access.worldpay.com/
merchantIdYour unique merchant ID.

Implement your CvcOnlyValidationEventListener

To receive validation results of your customer's cvc details, you are required to create your own implementation of the CvcOnlyValidationEventListener interface. Each of the function of this interface is optional to give you flexibility to listen to the events that you care about.

Copied!
const validationEventListener = {

  onCvcValidChanged(isValid) {
    // TODO: handle the cvc validation result
  },

  onValidationSuccess() {
    // TODO: handle the form when the validation is complete i.e. all fields are valid
  },
};
import {
  ...
  CvcOnlyValidationEventListener,
} from '@worldpay-beta/access-worldpay-checkout-react-native-sdk-beta';

const validationEventListener: CvcOnlyValidationEventListener = {

  onCvcValidChanged(isValid: boolean): void {
    // TODO: handle the cvc validation result
  },

  onValidationSuccess(): void {
    // TODO: handle the form when the validation is complete i.e. all fields are valid
  },
};

Methods

MethodDescription
onCvcValidChangedThis method is called with the validity of the CVC field. isValid indicates whether the field is in a valid or invalid state.
onValidationSuccessThis method is called when all fields are in a valid state. You typically use this to enable the submit button.

Call our hook to get the validation initialization function

You must now call our hook to get an instance of the function which will be used to initialize the validation of your UI.

To do this,

  1. create a CvcOnlyValidationConfig to specify the id of the CVC TextInput.
  2. then call the useCvcOnlyValidation() hook passing on the accessCheckout, the CvcOnlyValidationConfig and your CvcOnlyValidationEventListener implementation.

In result you will get an object with an initialiseCvcOnlyValidation property containing the function to use to effectively initialize the validation.

Here is an example detailing how to do this.

Copied!
import {
  ...
  CvcOnlyValidationConfig,
  useCvcOnlyValidation,
} from '@worldpay-beta/access-worldpay-checkout-react-native-sdk-beta';

const validationConfig = new CvcOnlyValidationConfig({
  cvcId: 'cvcInput',
});

const { initialiseCvcOnlyValidation } = useCvcOnlyValidation(
  accessCheckout,
  validationConfig,
  validationEventListener
);

Initialize the validation

You can now initialize the validation using the initialiseCvcOnlyValidation() function. Before doing so, you need to make sure that your UI components for CVC are available in the DOM.

Validation initialization is an asynchronous process so make sure to handle the promise returned by the function.

Copied!
import React from 'react';
import { ..., View } from 'react-native';
  ...
  <View
    onLayout={() => {
      initialiseCvcOnlyValidation()
        .then(() => {
          // You may want to optionally perform some actions once validation has been successfully initialized.
        })
        .catch((error) => {
          // do something in case of error
        });
    }}
  >
    ...
  </View>
  ...

Full code sample

Here's the full code sample of the steps above.

Copied!
import {
  AccessCheckout,
  CvcOnlyValidationConfig,
  useCvcOnlyValidation,
} from '@worldpay-beta/access-worldpay-checkout-react-native-sdk-beta';
import React from 'react';
import {TextInput, View} from 'react-native';

export default function CvcFlow() {
  const accessCheckout = new AccessCheckout({
    baseUrl: 'https://try.access.worldpay.com/',
    merchantId: 'YOUR_MERCHANT_ID',
  });

  const validationEventListener = {

    onCvcValidChanged(isValid) {
      // TODO: handle the cvc validation result
    },

    onValidationSuccess() {
      // TODO: handle the form when the validation is complete i.e. all fields are valid
    },
  };

  const validationConfig = new CvcOnlyValidationConfig({
    cvcId: 'cvcInput',
  });

  const { initialiseCvcOnlyValidation } = useCvcOnlyValidation(
    accessCheckout,
    validationConfig,
    validationEventListener,
  );

  return (
    <View
      onLayout={() => {
        initialiseCvcOnlyValidation()
          .then(() => {
            // You may want to optionally perform some actions once validation has been successfully initialized.
          })
          .catch((error) => {
            // do something in case of error
          });
      }}
    >
      <TextInput
        nativeID="cvcInput"
        keyboardType="numeric"
        placeholder="CVC"
      />
    </View>
  );
}
import {
  AccessCheckout,
  CvcOnlyValidationConfig,
  CvcOnlyValidationEventListener,
  useCvcOnlyValidation,
} from '@worldpay-beta/access-worldpay-checkout-react-native-sdk-beta';
import React from 'react';
import { TextInput, View } from 'react-native';

export default function CvcFlow() {
  const accessCheckout = new AccessCheckout({
    baseUrl: 'https://try.access.worldpay.com/',
    merchantId: 'YOUR_MERCHANT_ID',
  });

  const validationEventListener: CvcOnlyValidationEventListener = {

    onCvcValidChanged(isValid: boolean): void {
      // TODO: handle the cvc validation result
    },

    onValidationSuccess(): void {
      // TODO: handle the form when the validation is complete i.e. all fields are valid
    },
  };

  const validationConfig = new CvcOnlyValidationConfig({
    cvcId: 'cvcInput',
  });

  const { initialiseCvcOnlyValidation } = useCvcOnlyValidation(
    accessCheckout,
    validationConfig,
    validationEventListener
  );

  return (
    <View
      onLayout={() => {
        initialiseCvcOnlyValidation()
          .then(() => {
            // You may want to optionally perform some actions once validation has been successfully initialized.
          })
          .catch((error) => {
            // do something in case of error
          });
      }}
    >
      <TextInput
        nativeID="cvcInput"
        keyboardType="numeric"
        placeholder="CVC"
      />
    </View>
  );
}


Next steps


Create a CVC session