Skip to main content

billingDetails

Customer's billing details.

Note: For single-use Payment Handles, this address information will be ignored if the paymentHandleTokenFrom parameter is included in the Payment Handle creation request and there is already address information associated with that customer.

idstring

This is the ID of the billing address, returned in the response.

Possible values: <= 36 characters

statusstring

This is the status of the address.

nickNamestring

This is the nickname the merchant has for the billing address.

Possible values: <= 50 characters

Example: Home
streetstringrequired

This is the first line of the customer's street address.

Possible values: <= 50 characters

Example: Street
street1string

This is the first line of the street address.

Note: Mandatory for VIPPreferred

Possible values: <= 50 characters

Example: street1
street2string

This is the second line of the street address, if required (e.g., apartment number).

Possible values: <= 50 characters

Example: street2
citystringrequired

This is the city where the address is located.

Possible values: <= 40 characters

Example: Toronto
statestring

This is the state/province/region in which the customer lives.

Possible values: >= 2 characters and <= 40 characters

Example: ON
countrystringrequired

This is the country where the address is located. See Country Codes.

Possible values: >= 2 characters and <= 2 characters

Example: CA
zipstringrequired

This is the zip, postal, or post code of the customer's address.

Possible values: <= 10 characters

Example: M5H 2N2
phonestring

This is the customer's telephone number.

Possible values: <= 40 characters

Example: 8765846321
billingDetails
{
"id": "string",
"status": "string",
"nickName": "Home",
"street": "Street",
"street1": "street1",
"street2": "street2",
"city": "Toronto",
"state": "ON",
"country": "CA",
"zip": "M5H 2N2",
"phone": "8765846321"
}