ShippingAddress: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
(Created page with "= Shipping address object = This object represents a shipping address related to a payment. == API usage == This object is used by the following API endpoints: * Payment...")
 
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
= Shipping address object =
= Shipping address structure =


This object represents a shipping address related to a payment.
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 ==  
== API usage ==  


This object is used by the following API endpoints:
This structure is used by the following API endpoints:
* [[Payment-Start-v2]]
* [[Payment-Start-v2]]


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.
|| 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 || * Optional || The complete name of the city of the recipient address.
| City || string ||  
* Optional, required if region is specified
* Maximum 50 characters
|| 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 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. For example in case of Hungary, use the [https://en.wikipedia.org/wiki/ISO_3166-2:HU Wikipedia example] after the HU-
'''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 || The zip code of the recipient address.
| Zip || string ||  
* Optional  
* Maximum 16 characters
|| The zip code of the recipient address.
|-
|-
| Street || string || * Optional || The shipping street address with house number and other details.
| Street || string ||  
* Optional  
* Maximum 50 characters
|| The shipping street address with house number and other details.
|-
|-
| Street2 || string || * Optional || The address, continued.
| Street2 || string ||  
* Optional  
* Maximum 50 characters
|| The address, continued.
|-
|-
| FullName || string || * Optional || The full civil or official name of the recipient.
| Street3 || string ||  
* Optional
* Maximum 50 characters
|| The address, continued.
|-
|-
| Phone || string || * Optional || The phone number of the recipient.
| FullName || string ||  
* Optional
* Maximum 45 characters
|| The name of the customer on the shipping address
|-
|-
|}

Latest revision as of 10:03, 1 December 2020

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. For example in case of Hungary, use the Wikipedia example after the HU-

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
Retrieved from "https://docs.barion.com/index.php?title=ShippingAddress&oldid=2883"