Difference between revisions of "ShippingAddress"

From Barion Documentation
Jump to navigation Jump to search
(Property list)
(Property list)
 
(7 intermediate revisions by 3 users not shown)
Line 11: Line 11:
  
 
{{api_input_table_header}}
 
{{api_input_table_header}}
|-
 
| DeliveryMethod || string ||
 
* Optional
 
|| The delivery method, if applicable.
 
 
|-
 
|-
 
| Country || string ||  
 
| Country || string ||  
* Optional
+
* Required
 
* Exactly 2 characters
 
* Exactly 2 characters
|| The recipient's country code in ISO-3166-1 format. E.g. HU or DE. If you are not able to provide the country send <tt>ZZ</tt> as the country code.  
+
|| The payer's country code in ISO-3166-1 format. E.g. HU or DE. If you cannot provide the shipping address, send <code>ZZ</code> as the country code.  
 
|-
 
|-
 
| City || string ||  
 
| City || string ||  
 
* Optional, required if region is specified
 
* Optional, required if region is specified
 +
* Maximum 50 characters
 
|| The complete name of the city of the recipient address.  
 
|| The complete name of the city of the recipient address.  
 
|-
 
|-
| Region || string ||  
+
| Region || string or '''null''' ||  
 
* Optional  
 
* Optional  
 
* Exactly 2 characters
 
* Exactly 2 characters
|| The region code (state or county) of the recipient address in ISO-3166-2 format
+
|| The country subdivision code (state or county) of the recipient address in ISO-3166-2 format
 +
'''Note:''' if this does not apply to the given country, send a '''null''' value or do not send this property at all.
 
|-
 
|-
 
| Zip || string ||  
 
| Zip || string ||  
 
* Optional  
 
* Optional  
 +
* Maximum 16 characters
 
|| The zip code of the recipient address.
 
|| The zip code of the recipient address.
 
|-
 
|-
 
| Street || string ||  
 
| Street || string ||  
 
* Optional  
 
* Optional  
 +
* Maximum 50 characters
 
|| The shipping street address with house number and other details.
 
|| The shipping street address with house number and other details.
 
|-
 
|-
 
| Street2 || string ||  
 
| Street2 || string ||  
 
* Optional  
 
* Optional  
 +
* Maximum 50 characters
 
|| The address, continued.
 
|| The address, continued.
 
|-
 
|-
 
| Street3 || string ||  
 
| Street3 || string ||  
* Optional  
+
* Optional
 +
* Maximum 50 characters
 
|| The address, continued.
 
|| The address, continued.
 
|-
 
|-
 
| FullName || string ||  
 
| FullName || string ||  
* Optional  
+
* Optional
|| The full civil or official name of the recipient.
+
* Maximum 45 characters
|-
+
|| The name of the customer on the shipping address
| Phone || string ||
 
* Optional
 
|| The phone number of the recipient.
 
 
|-
 
|-
 
|}
 
|}

Latest revision as of 11:45, 3 September 2019

Shipping address structure

This structure represents a shipping address related to a payment. The data provided here is used to analyze and avoid possible fraud attempts.

API usage

This structure is used by the following API endpoints:

Property list

Property name Property type Limitations and constraints Description
Country string
  • Required
  • Exactly 2 characters
The payer's country code in ISO-3166-1 format. E.g. HU or DE. If you cannot provide the shipping address, send ZZ as the country code.
City string
  • Optional, required if region is specified
  • Maximum 50 characters
The complete name of the city of the recipient address.
Region string or null
  • Optional
  • Exactly 2 characters
The country subdivision code (state or county) of the recipient address in ISO-3166-2 format

Note: if this does not apply to the given country, send a null value or do not send this property at all.

Zip string
  • Optional
  • Maximum 16 characters
The zip code of the recipient address.
Street string
  • Optional
  • Maximum 50 characters
The shipping street address with house number and other details.
Street2 string
  • Optional
  • Maximum 50 characters
The address, continued.
Street3 string
  • Optional
  • Maximum 50 characters
The address, continued.
FullName string
  • Optional
  • Maximum 45 characters
The name of the customer on the shipping address