Checkout icon

Upgrade to Checkout API v72

Find what you must do to upgrade to Checkout API v72.

Checkout API v72 introduces validations to the values that you send in API requests. To upgrade to this version, you must make sure that the data you send meets our validations.

Requirements

Requirement Description
Integration type An online payments integration that uses Checkout API.
API credential roles Make sure that you have the following role:
  • Checkout webservice role
Customer Area roles Make sure that you have one of the following roles:
  • Merchant admin role
  • Manage API credentials

Validate the data that you send

Check that the values that you send in each parameter in the following table meets the validations.

Parameter Validation requirement
billingAddress.postalCode Maximum length: 10 characters.
billingAddress.stateOrProvinceCode Maximum length: 10 characters.
captureDelayHours Maximum value: 672. This maximum value corresponds to 28 (twenty-eight) days.
dateOfBirth Format requirement:
Must be in ISO-8601 format with the date (YYYY-MM-DD). Example: 2005-03-01 (March 1, 2025).
deliveryAddress.postalCode Maximum length: 10 characters.
deliveryAddress.stateOrProvinceCode Format requirement:
Maximum length:
  • 2 characters.
entityType Possible values:
  • NaturalPerson
  • CompanyName
metadata Maximum lengths:
  • For the key: 20 characters.
  • For the value: 80 characters.
reference Maximum length: 80 characters.
returnUrl Format requirement:
  • Must meet the RFC 2396 standard. If the URL to return to includes non-ASCII characters, like spaces or special letters, you must URL encode the value.

Maximum length:
  • 1024 characters.
shopperEmail Format requirements:
  • Must not have spaces.
  • Must contain the at symbol character(@) .
  • Must contain text before and after the at symbol character (@).
  • The email domain must not start with the period character (.).
  • The username must not include the quotation marks character ("), unless the whole name is in quotation marks.

Maximum length:
  • 256 characters.
shopperIP Maximum length: 256 characters.
shopperName.firstName Maximum length: 100 characters.
shopperName.lastName Maximum length: 100 characters.
socialSecurityNumber Maximum length: 50 characters.
telephoneNumber Maximum length: 64 characters.