Registration with pre-filled values: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
 
(12 intermediate revisions by 4 users not shown)
Line 9: Line 9:
'''Important:''' this is just a convinience feature! By modifying the URL the user can remove these values whenever they want.
'''Important:''' this is just a convinience feature! By modifying the URL the user can remove these values whenever they want.


==Query string parameters for registering as an individual==
==Registration Type Query String Parameter==
 
The "mode" query string parameter is used to determine the type of registration being requested in the API. We distinguish two registration types: personal and business.
 
{| class="wikitable api-table"
|-
! Query string parameter
! Parameter type
! Parameter description
|-
| mode
| string
| Indicates the registration type: <code>naturalperson</code> or <code>business</code>.
|}
 
'''Note:''' To accommodate legacy integrations, we support two additional values for the "mode" query string parameter: "NaturalPerson" for personal registration and "Organization" for business registration.
 
==Personal Wallet Registration Query String Parameters==


{| class="wikitable api-table"
{| class="wikitable api-table"
Line 29: Line 46:
'''Example:'''
'''Example:'''
<source lang="powershell">
<source lang="powershell">
https://secure.barion.com/Registration?mode=NaturalPerson&m=user%40example.com&isEmailLocked=true
https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true
</source>
</source>


==Query string parameters for registering as an organization==
==Business Wallet Registration Query String Parameters==


{| class="wikitable api-table"
{| class="wikitable api-table"
Line 51: Line 68:
| string
| string
| The name of the organization.
| The name of the organization.
|-
| onm
| bool
| Indicates if the name and short name of the organization match.
|-
| osn
| string
| Short name of the organization.
|-
| oc
| string
| The 3-letter iso code of the headquarters address country  (eg. HUN for Hungary, CZE for Czechia).
|-
|-
| ot
| ot
Line 67: Line 96:
| string
| string
| The house number for the headquarters address.
| The house number for the headquarters address.
|-
| oam
| bool
| Indicates, whether the headquarters and the postal address match.
|-
| ocat
| string
| The category number of the organization (so called TEÁOR in hungarian). Only the numerical value (eg: <code>0520</code>) is required.
|-
| orn
| string
| The registration number of the organization.
|-
| otn
| string
| The tax number of the organization.
|-
| pc
| string
| The postal country of the organization.
|-
| ppa
| string
| The postal zip code of the organization.
|-
| pt
| string
| The postal city of the organization.
|-
| phn
| string
| The postal house number of the organization.
|-
| rfn
| string
| The organization representative's first name.
|-
| rln
| string
| The organization representative's last name.
|-
| rmfn
| string
| The organization representative mother's first name.
|-
| rmln
| string
| The organization representative mother's last name.
|-
| rn
| string
| The 3-letter country code of the organization representative's nationality (eg. HUN for Hungary, CZE for Czechia).
|-
| rbp
| string
| The organization representative's birth place.
|-
| rbd
| string
| The organization representative's birth date (eg: 1990-01-01).
|-
| rbp
| string
| The organization representative's position (eg. CEO).
|-
| rc
| string
| The 3-letter iso country code of the organization representative's address (eg. HUN for Hungary, CZE for Czechia).
|-
| rpa
| string
| The zip code of the organization representative's address.
|-
| rt
| string
| The city of the organization representative's address.
|-
| rs
| string
| The street of the organization representative's address.
|-
| rhn
| string
| The house number of the organization representative's address.
|-
| rpcc
| string
| The prefix country code of the organization representative's phone number (eg. 36 for Hungary, 420 for Czechia).
|-
| rpn
| string
| The phone number of the organization representative without the country code (eg. 205555555 for a valid hungarian phone number).
|-
|-
|}
|}
Line 72: Line 193:
'''Example:'''
'''Example:'''
<source lang="powershell">
<source lang="powershell">
https://secure.barion.com/Registration?mode=Organization&[email protected]&on=Testdata+Company+Ltd&opa=98332&ot=San+José&os=Rockwood+Creek&ohn=32
https://secure.barion.com/Registration?mode=Business&[email protected]&on=Testdata+Company+Ltd&opa=98332&ot=San+José&os=Rockwood+Creek&ohn=32
</source>
</source>


Line 86: Line 207:
| r
| r
| string
| string
| The E-mail address OR topup code of the referring user, if applicable.
| The topup code of the referring user, if applicable.
|-
|-
| url
| url
| boolean
| string
| The URL where the user should be redirected upon successful registration. The e-mail address entered at the registration is appended to the URL as a query string parameter.
| The URL where the user should be redirected upon successful registration. The e-mail address entered at the registration is appended to the URL as a query string parameter.
'''Warning:''' this feature is under development and is subject to change without notice!
'''Warning:''' this feature is under development and is subject to change without notice!
Line 100: Line 221:


<source lang="powershell">
<source lang="powershell">
https://secure.barion.com/Registration?mode=NaturalPerson&m=user%40example.com&isEmailLocked=true&r=123456789&url=https://www.example.com/successfulregistration
https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true&r=123456789&url=https://www.example.com/successfulregistration
</source>
</source>

Latest revision as of 17:38, 6 June 2023

Opening the Barion wallet registration page with pre-filled values

There are certain situations and business models where the user is required to obtain a Barion wallet before they are able to pay for goods or services in the shop. Automatically registering a Barion wallet for a user by third parties is strictly prohibited by law. However, Barion aids the third party in a way so they can supply specific values to pre-fill the registration form, so the process can be completed faster by the user. By using the following query string parameters, the third party can redirect the user to the Barion registration form so some fields are already filled for them.

Important: this is just a convinience feature! By modifying the URL the user can remove these values whenever they want.

Registration Type Query String Parameter

The "mode" query string parameter is used to determine the type of registration being requested in the API. We distinguish two registration types: personal and business.

Query string parameter Parameter type Parameter description
mode string Indicates the registration type: naturalperson or business.

Note: To accommodate legacy integrations, we support two additional values for the "mode" query string parameter: "NaturalPerson" for personal registration and "Organization" for business registration.

Personal Wallet Registration Query String Parameters

Query string parameter Parameter type Parameter description
m string The E-mail address of the user.
isEmailLocked boolean Indicates wether the E-mail address field is locked or editable - true means locked, false means editable.

Example:

https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true

Business Wallet Registration Query String Parameters

Query string parameter Parameter type Parameter description
m string The E-mail address of the user.
isEmailLocked boolean Indicates wether the E-mail address field is locked or editable - true means locked, false means editable.
on string The name of the organization.
onm bool Indicates if the name and short name of the organization match.
osn string Short name of the organization.
oc string The 3-letter iso code of the headquarters address country (eg. HUN for Hungary, CZE for Czechia).
ot string The city for the headquarters address.
opa string The postal/zip code for the headquarters address.
os string The street name for the headquarters address.
ohn string The house number for the headquarters address.
oam bool Indicates, whether the headquarters and the postal address match.
ocat string The category number of the organization (so called TEÁOR in hungarian). Only the numerical value (eg: 0520) is required.
orn string The registration number of the organization.
otn string The tax number of the organization.
pc string The postal country of the organization.
ppa string The postal zip code of the organization.
pt string The postal city of the organization.
phn string The postal house number of the organization.
rfn string The organization representative's first name.
rln string The organization representative's last name.
rmfn string The organization representative mother's first name.
rmln string The organization representative mother's last name.
rn string The 3-letter country code of the organization representative's nationality (eg. HUN for Hungary, CZE for Czechia).
rbp string The organization representative's birth place.
rbd string The organization representative's birth date (eg: 1990-01-01).
rbp string The organization representative's position (eg. CEO).
rc string The 3-letter iso country code of the organization representative's address (eg. HUN for Hungary, CZE for Czechia).
rpa string The zip code of the organization representative's address.
rt string The city of the organization representative's address.
rs string The street of the organization representative's address.
rhn string The house number of the organization representative's address.
rpcc string The prefix country code of the organization representative's phone number (eg. 36 for Hungary, 420 for Czechia).
rpn string The phone number of the organization representative without the country code (eg. 205555555 for a valid hungarian phone number).

Example:

https://secure.barion.com/Registration?mode=Business&[email protected]&on=Testdata+Company+Ltd&opa=98332&ot=San+José&os=Rockwood+Creek&ohn=32

Other query string parameters

These extra parameters can be used on both the individual and the organization registration page.

Query string parameter Parameter type Parameter description
r string The topup code of the referring user, if applicable.
url string The URL where the user should be redirected upon successful registration. The e-mail address entered at the registration is appended to the URL as a query string parameter.

Warning: this feature is under development and is subject to change without notice!

Example:

Individual registration with referrer and redirect URL:

https://secure.barion.com/Registration?mode=Personal&m=user%40example.com&isEmailLocked=true&r=123456789&url=https://www.example.com/successfulregistration