BillingAddress: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
 
(8 intermediate revisions by 4 users not shown)
Line 6: Line 6:


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


== Property list ==
== Property list ==
Line 13: Line 13:
|-
|-
| Country || string ||  
| Country || string ||  
* Optional
* Required
* Exactly 3 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 are not able to provide the billing address, send <code>ZZ</code> as the country code.  
|-
|-
| City || string ||  
| City || string ||  
* Optional  
* Optional
* 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 3 characters
* Exactly 2 characters
|| The region code of the recipient address in ISO-3166-2 format
|| The country subdivision code 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
* Maximum 50 characters
|| The address, continued.
|-
| Street3 || string ||
* Optional  
* Optional  
* Maximum 50 characters
|| The address, continued.
|| The address, continued.
|-
|-
|}
|}

Latest revision as of 04:18, 10 September 2019

Billing address structure

This structure represents a billing address related to a payment. The data provided here is used to analyze and avoid possible fraud attempts and assure frictionless 3D secure flow.

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 are not able to provide the billing address, send ZZ as the country code.
City string
  • Optional
  • 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 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.