Verifone · Schema

Phone number

A simple Phone Number

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
callingCode string Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE
value string The actual phone number less country code and/or extension.
extension string The internal extension number where applicable or known.
isPrimary boolean Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY
phoneType object
View JSON Schema on GitHub

JSON Schema

order-service-api-phone.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/order-service-api-phone.json",
  "title": "Phone number",
  "description": "A simple Phone Number",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "callingCode": {
      "description": "Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE",
      "type": "string"
    },
    "value": {
      "description": "The actual phone number less country code and/or extension.",
      "type": "string",
      "minLength": 5
    },
    "extension": {
      "description": "The internal extension number where applicable or known.",
      "type": "string"
    },
    "isPrimary": {
      "description": "Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY",
      "type": "boolean",
      "default": false
    },
    "phoneType": {
      "$ref": "#/components/schemas/PhoneTypeEnum"
    }
  },
  "required": [
    "value",
    "phoneType"
  ]
}