ShippingAddress: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 11: Line 11:


{{api_input_table_header}}
{{api_input_table_header}}
|-
| DeliveryMethod || string ||
* Optional
|| The delivery method, if applicable.
|-
|-
| Country || string ||  
| Country || string ||  
Line 45: Line 41:
* Optional  
* Optional  
|| The address, continued.
|| The address, continued.
|-
| FullName || string ||
* Optional
|| The full civil or official name of the recipient.
|-
| Phone || string ||
* Optional
|| The phone number of the recipient.
|-
|-
|}
|}

Revision as of 08:10, 31 July 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
The complete name of the city of the recipient address.
Region string
  • Optional
  • Exactly 2 characters
The country subdivision code (state or county) of the recipient address in ISO-3166-2 format
Zip string
  • Optional
The zip code of the recipient address.
Street string
  • Optional
The shipping street address with house number and other details.
Street2 string
  • Optional
The address, continued.
Street3 string
  • Optional
The address, continued.