ShippingAddress: Difference between revisions
Jump to navigation
Jump to search
| Line 25: | Line 25: | ||
* Optional | * Optional | ||
* Exactly 2 characters | * Exactly 2 characters | ||
|| The country subdivision 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. 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. | '''Note:''' if this does not apply to the given country, send a '''null''' value or do not send this property at all. | ||
|- | |- | ||
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 |
|
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 |
|
The complete name of the city of the recipient address. |
| Region | string or null |
|
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 |
|
The zip code of the recipient address. |
| Street | string |
|
The shipping street address with house number and other details. |
| Street2 | string |
|
The address, continued. |
| Street3 | string |
|
The address, continued. |
| FullName | string |
|
The name of the customer on the shipping address |