ShippingAddress

From Barion Documentation
Revision as of 11:45, 3 September 2019 by Vinczei (talk | contribs) (Property list)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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