Skip to main content

Card Tokenization Request

Credit or debit card details for card proxy creation.

cardHolderNamestring

Card holder name.

cardNumberstringrequired

Credit/Debit Card number.

customerUniqueIdstring

Customer unique identifier.

expirystringrequired

Card expiry in MM/yy format.

Example: MM/yy
paymentAmountnumber<double>

Amount is optional. If provided, the applicable pricing will be returned in the result.

threeDSecureData object

Conditional. Pass the values if 3DSecure is required.

browserData object

Cardholder's browser data. Mandatory if UseThreeDSecure is true.

acceptHeaderstring

Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder's browser.

colorDepthinteger<int32>

Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property. Possible values: 1, 4, 8, 15, 16, 24, 32, 48.

ipAddressstring

IP address of the browser as returned by the HTTP headers to the 3DS Requestor.

languagestring

Value representing the browser language as defined in IETF BCP47. The value is limited to 1-8 characters. Value is returned from navigator.language property.

screenHeightinteger<int32>

Total height of the Cardholder's screen in pixels. Value is returned from the screen.height property.

screenWidthinteger<int32>

Total width of the Cardholder's screen in pixels. Value is returned from the screen.width property.

timezonestring

Time difference between UTC time and the Cardholder browser local time, in minutes. The field is limited to 1-5 characters where the value is returned from the getTimezoneOffset() method.

userAgentstring

Exact content of the HTTP user-agent header. The field is limited to maximum 2048 characters. Obtained from Cardholder browser using the navigator.userAgent property.

callbackUrlstring

Endpoint to receive status notifications once 3DSecure is completed. Use [uniqueId] (case sensitive) in URL to differentiate different payments and 3DS statuses For example: CallbackUrl https://www.yourdomain.com.au/3dsecure/[uniqueId] will be translated to https://www.yourdomain.com.au/callbacks/123456 assuming uniqueId is 123456.

redirectUrlstring

Redirect URL used to redirect once the 3DSecure process is completed. Use [uniqueId], [status] (case sensitive) in URL to differentiate different payments and 3DS statuses For example: RedirectUrl https://www.yourdomain.com.au/3dsecure/[uniqueId]?status=[status] will be translated to https://www.yourdomain.com.au/3dsecure/123456?status=Success assuming uniqueId is 123456 Possible 3DSecure statuses: Success, Failed, Cancelled.

useThreeDSecureboolean

Will trigger 3DSecure process if enabled or valid for the card.

Card Tokenization Request
{
  "cardHolderName": "string",
  "cardNumber": "string",
  "customerUniqueId": "string",
  "expiry": "MM/yy",
  "paymentAmount": 0,
  "threeDSecureData": {
    "browserData": {
      "acceptHeader": "string",
      "colorDepth": 0,
      "ipAddress": "string",
      "language": "string",
      "screenHeight": 0,
      "screenWidth": 0,
      "timezone": "string",
      "userAgent": "string"
    },
    "callbackUrl": "string",
    "redirectUrl": "string",
    "useThreeDSecure": true
  }
}