phone

The phone element has multiple uses in cnpAPI depending upon the parent element. When used as a child of either the billToAddress or shipToAddress elements, it defines the customers phone number.

phone as a child of billToAddress and shipToAddress

The phone element defines the customer’s phone number in both the billToAddress and shipToAddress elements

When submitting an eCheck Verification, the string can only contain numbers (0 through 9). Letters and special characters are not allowed.

Type = String; minLength = N/A; maxLength = 20

 

Parent Elements:

billToAddress, shipToAddress

 

Attributes:

None

 

Child Elements:

None

 

phone as a child of customBilling

When used as a child of the customBilling element, phone defines the merchant’s phone number. The string can only contain numbers (0 through 9). Letters and special characters are not allowed.

 

Type = String; minLength = N/A; maxLength = 13

 

Parent Elements:

customBilling

 

Attributes:

None

 

Child Elements:

None

 

phone as a child of retailerAddress

The phone element as a child of retailerAddress defines the retailer’s phone number.

Type = String; minLength = N/A; maxLength = 20

 

Parent Elements:

retailerAddress

 

Attributes:

None

 

Child Elements:

None

 

phone as a child of sellerInfo

The phone element as an optional child of sellerinfo defines the seller’s phone number. You use this element when submitting transactions to the Guaranteed Payments service.

Type = String; minLength = N/A; maxLength = 100

 

Parent Elements:

sellerInfo

 

Attributes:

None

 

Child Elements:

None