Difference between revisions of "RecipientAddress"

From Barion Documentation
Jump to navigation Jump to search
 
(2 intermediate revisions by 2 users not shown)
Line 12: Line 12:
 
{{api_input_table_header}}
 
{{api_input_table_header}}
 
|-
 
|-
| Country || string ||  
+
| Country
 +
| string
 +
|
 
* Required
 
* Required
|| The country of the recipient, in 3-letter country code (ISO 3166-1 Alpha-3) format
+
* Exactly 3 characters long
 +
| The country of the recipient, in 3-letter country code (ISO 3166-1 Alpha-3) format
 
|-
 
|-
| Street|| string ||  
+
| Street || string ||
 
* Required
 
* Required
* Maximum length: 60 characters for domestic transfers
+
||Street and street number part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.
* Maximum length: 35 characters for foreign transfers
 
|| Street and street number part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.
 
 
|-
 
|-
| City|| string ||  
+
| City || string ||  
 
* Required
 
* Required
* Maximum length: 60 characters for domestic transfers
 
* Maximum length: 35 characters for foreign transfers
 
 
|| City part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF.
 
|| City part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF.
 
|-
 
|-
| Zip|| string ||  
+
| Zip || string ||  
 
* Required
 
* Required
* Maximum length: 16 characters
+
* Max. 16 characters long
 
|| Zip part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.
 
|| Zip part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.
 
|-
 
|-
 
|}
 
|}
  
Note:
+
Additional length restrictions for this type apply based on currency:
* in case of domestic transfers, length of all fields combined shall be maximum 57 characters.
+
 
* Details on foreign/domestic terms: [[ForeignDomestic]]
+
* in the case of <strong>CZK</strong> currency:
 +
** <strong>Street</strong>: max. 35 characters
 +
** <strong>City</strong>: max. 35 characters
 +
* in the case of <strong>HUF</strong>, <strong>EUR</strong>, and <strong>USD</strong> currencies:
 +
** <strong>Sum of Street, City, And Zip</strong>: max. 54 characters
 +
 
 +
== Examples for recipient address ==
 +
 
 +
=== Valid Czech foreign transfer ===
 +
 
 +
Currency is <code>CZK</code>, bank account number format is <code>IBAN</code>.
 +
 
 +
All components are shorter than their maximum lengths.
 +
 
 +
  {
 +
    "Country": "Deu",
 +
    "Zip": "80804",
 +
    "City": "München",
 +
    "Street": "Leopoldstraße 146."
 +
  }
 +
 
 +
=== Invalid Czech foreign transfer ===
 +
 
 +
Currency is <code>CZK</code>, bank account number format is <code>IBAN</code>.
 +
 
 +
<code>Street</code> is 36 characters long, making the address invalid for CZK transfers.
 +
 
 +
  {
 +
    "Country": "Hun",
 +
    "Zip": "1183",
 +
    "City": "Budapest",
 +
    "Street": "Ferihegyi repülőtérre vezető út 23/B"
 +
  }
 +
 
 +
=== Valid EUR transfer ===
 +
 
 +
Currency is <code>EUR</code> (note: same rules for <code>USD</code> and foreign <code>HUF</code>), bank account number format is <code>IBAN</code>.
 +
 
 +
<code>Street</code> is 36 characters long, <code>City</code> is 8 characters long, and <code>Zip</code> is 4. The sum is 48, which is &lt;= 54 so this address is valid for this transfer.
 +
 
 +
  {
 +
    "Country": "Hun",
 +
    "Zip": "1183",
 +
    "City": "Budapest",
 +
    "Street": "Ferihegyi repülőtérre vezető út 23/B"
 +
  }
 +
 
 +
=== Invalid EUR transfer ===
 +
 
 +
Currency is <code>EUR</code>, bank account number format is <code>IBAN</code>.
 +
 
 +
<code>Street</code> is 58 characters long, which is in itself longer than the total allowed 54 for <code>Street</code>, <code>City</code>, and <code>Zip</code>.
 +
 
 +
  {
 +
    "Country": "Hun",
 +
    "Zip": "1183",
 +
    "City": "Budapest",
 +
    "Street": "Ferihegyi repülőtérre vezető út 23/B 7. emelet 27-es lakás"
 +
  }
 +
 
 +
<code>Zip</code> is more than 16 characters long, which makes the address invalid even if the total for the three components that are counted in the maximum 54 characters is short enough.
 +
 
 +
  {
 +
    "Country": "Nar",
 +
    /* Narnia is a very big country, too many zip codes */
 +
    "Zip": "61248531479548248",
 +
    "City": "Snowy Mountain",
 +
    "Street": "Yak Street 35."
 +
  }
 +
 
 +
 
 +
=== Valid domestic CZK and HUF transfers ===
 +
 
 +
The same rules apply to domestic <code>CZK</code> and <code>HUF</code> transfers as to foreign <code>CZK</code> and <code>HUF</code> transfers, respectively. If the address is invalid, it can be omitted in the case of domestic transfers, making the whole transfer valid again.

Latest revision as of 13:39, 16 August 2022

This structure represents recipient address that is used as the recipient of an outgoing bank (wire) transfer from the Barion system.

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 3 characters long
The country of the recipient, in 3-letter country code (ISO 3166-1 Alpha-3) format
Street string
  • Required
Street and street number part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.
City string
  • Required
City part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF.
Zip string
  • Required
  • Max. 16 characters long
Zip part of the address of the recipient. Used when transferring money outside Hungary and/or other than HUF and for fraud analysis.

Additional length restrictions for this type apply based on currency:

  • in the case of CZK currency:
    • Street: max. 35 characters
    • City: max. 35 characters
  • in the case of HUF, EUR, and USD currencies:
    • Sum of Street, City, And Zip: max. 54 characters

Examples for recipient address

Valid Czech foreign transfer

Currency is CZK, bank account number format is IBAN.

All components are shorter than their maximum lengths.

 {
   "Country": "Deu",
   "Zip": "80804",
   "City": "München",
   "Street": "Leopoldstraße 146."
 }

Invalid Czech foreign transfer

Currency is CZK, bank account number format is IBAN.

Street is 36 characters long, making the address invalid for CZK transfers.

 {
   "Country": "Hun",
   "Zip": "1183",
   "City": "Budapest",
   "Street": "Ferihegyi repülőtérre vezető út 23/B"
 }

Valid EUR transfer

Currency is EUR (note: same rules for USD and foreign HUF), bank account number format is IBAN.

Street is 36 characters long, City is 8 characters long, and Zip is 4. The sum is 48, which is <= 54 so this address is valid for this transfer.

 {
   "Country": "Hun",
   "Zip": "1183",
   "City": "Budapest",
   "Street": "Ferihegyi repülőtérre vezető út 23/B"
 }

Invalid EUR transfer

Currency is EUR, bank account number format is IBAN.

Street is 58 characters long, which is in itself longer than the total allowed 54 for Street, City, and Zip.

 {
   "Country": "Hun",
   "Zip": "1183",
   "City": "Budapest",
   "Street": "Ferihegyi repülőtérre vezető út 23/B 7. emelet 27-es lakás"
 }

Zip is more than 16 characters long, which makes the address invalid even if the total for the three components that are counted in the maximum 54 characters is short enough.

 {
   "Country": "Nar",
   /* Narnia is a very big country, too many zip codes */
   "Zip": "61248531479548248",
   "City": "Snowy Mountain",
   "Street": "Yak Street 35."
 }


Valid domestic CZK and HUF transfers

The same rules apply to domestic CZK and HUF transfers as to foreign CZK and HUF transfers, respectively. If the address is invalid, it can be omitted in the case of domestic transfers, making the whole transfer valid again.