Links

Common payment objects

Learn about payment objects that are common to all payment methods.

Owner object

Owner object example
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"phoneNumber": "000-000-0000",
"organization": "Digital River",
"address": {
"line1": "1-16-24 Minami-gyotoku",
"line2": "Ichikawa-shi",
"city": "Chiba",
"state": "Kyongsangnamdo",
"postalCode": "272-0138",
"country": "JP"
}
}
Field
Required/Optional
Description
firstName
Required
The customer's first name as it appears on the payment instrument.
lastName
Required
The customer's last name as it appears on the payment instrument.
phoneNumber
Required
The customer's phone number.
email
Required
The customer's email address.
organization
Optional
The customer's organization
address
Required
additionalAddressInfo
Optional
Additional address fields may be required for certain payment types.

Address object

Address object example
{
"line1": "1-16-24 Minami-gyotoku",
"line2": "Ichikawa-shi",
"city": "Chiba",
"state": "Kyongsangnamdo",
"postalCode": "272-0138",
"country": "JP"
}
Field
Required/Optional
Description
line1
Required
Line 1 of the Customer's billing address.
line2
Required
Line 2 of the Customer's billing address.
city
Required
City of the Customer's billing address.
state
Required
State of the Customer's billing address.
postalCode
Required
Postal Code of the Customer's billing address.
country
Required
Country of the Customer's billing address.

Additional address information object

Additional Address Information object
{
"neighborhood": "Centro",
"phoneticFirstName": "John",
"phoneticLastName": "Doe",
"division": "Development"
}
Field
Required/Optional
Description
neighborhood
Optional
The neighborhood associated with the address.
phoneticFirstName
Optional
The phonetic spelling of the customer's first name.
phoneticLastName
Optional
The phonetic spelling of the customer's last name.
countyName
Optional
The county associated with the address.
division
Optional
The division associated with the address.
title
Optional
The customer's title such as MR, MS, MISS, MRS, M, MME, or MLLE. Note: This field is required for Pay with Installments France.