Withdraw-BankTransfer-v2: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
VisualWikitext
No edit summary
mNo edit summary
 
(29 intermediate revisions by 5 users not shown)
Line 14: Line 14:
* [[Calling_the_API|Calling the Barion API]]
* [[Calling_the_API|Calling the Barion API]]


{{NotificationBox|title=WARNING|text=This API endpoint is obsolete as of August 2022. Please implement or migrate to [[Withdraw-BankTransfer-v3|/v3/Withdraw/BankTransfer]]|color=#FF7A3D}}
{{NotificationBox|title=IMPORTANT|text=Starting September 2022 this API endpoint does NOT accept withdrawal requests in CZK currency that are targeted <u>outside of Czechia</u>.|color=#FF7A3D}}


<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only.
<span class="api-ver">v2</span> This API endpoint is available in '''API v2''' only.
== Authentication ==
[[Barion Wallet Authentication]]


== Input properties ==
== Input properties ==


{{api_input_table_header}}
{{api_input_table_header}}
|-
| UserName || string ||
* Required
|| Your e-mail address in the Barion system.
|-
| Password || string ||
* Required
|| Your password in the Barion system.
|-
|-


| Currency || string ||  
| Currency || string ||  
* Required
* Required
* Required length: 3 characters
* Accepted values:
** "CZK" (Czech crown)
** "EUR" (Euro)
** "HUF" (Hungarian forint)
** "USD" (U.S. dollar)
|| The currency of the bank transfer.  
|| The currency of the bank transfer.  
'''Note:''' Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.
'''Note:''' Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency.
 
<span style="color:#920000;">'''Note:''' Withdraws in CZK currency that are targeted outside of Czechia are not supported on this endpoint starting September 2022.</span>
|-
|-


Line 94: Line 94:
| BankAccount|| [[BankAccount]] || The bank account data.
| BankAccount|| [[BankAccount]] || The bank account data.


|}
== Possible error responses  ==
{| class="wikitable api-table"
! Error code || Description
|-
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.
|-
| AuthenticationFailed || The provided authentication is not correct.
|-
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. '''This is not in production yet'''
|-
| InvalidCharacter || One of the characters is invalid for the bank transfer process
|-
| InvalidAccount || There is no account belonging to the user with the specified currency.
|-
| InappropriateVerificationLevel || The user does not have the verification level to be able to transfer.
|-
| InvalidCurrency || The system does not support the specified currency
|-
| InvalidCountry || The Country specified in the BankAccount field is invalid.
|-
| LowBalance || There are not enough funds to cover the withdraw amount and the fee.
|-
| BankAccountNumberBlackListed || The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended.
|-
| UserIsOverWithdrawLimit|| The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended.
|-
| UserIsDeleted || The user is deleted from the system, the withdraw is not possible.
|-
| UserIsSuspended || The user is suspended until the suspension is lifted no withdraws are allowed.
|-
| WithdrawFromCustomerAccountToSystemAccount || Withdraw to the specified target account is not allowed.
|-
| BankAccountNumberNotAllowed|| Target Bank account number not in the list of allowed bank account numbers for this account.
|-
| InternalServerError || Something unexpected happened
|-
| UnsupportedWithdraw || In the case of foreign CZK transfers (targeted outside of Czechia) this endpoint is not suitable to start the transfer. Please upgrade to the [[Withdraw-BankTransfer-v3|v3 version]].
|-
|}
== Bank transfer amount limitations  ==
{| class="wikitable api-table"
! Currency || Target country || Amount limitation
|-
| HUF || Anywhere || No limitation
|-
| EUR || Anywhere || No limitation
|-
| USD || Anywhere || No limitation
|-
| CZK || Czechia || No limitation
|-
| <s>CZK</s> || <s>Not Czechia</s> || <s>Minimum 100 CZK</s>
|-
|}
== Bank transfer character limitations  ==
{| class="wikitable api-table"
! Currency || Target country || Character limitation
|-
| HUF || Anywhere || No limitation
|-
| EUR || Anywhere || No limitation
|-
| USD || Anywhere || No limitation
|-
| CZK || Czechia || Allowed characters:
<pre>
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, ', +, !, ", #, $, %, &, *, ;, <, =, >, @, [, ], ^, `, {, |, }, ~, §, SPACE
</pre>
|-
| <s>CZK || <s>Not Czechia</s> || <s>Allowed characters:
<pre>
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, ', +, SPACE
</pre></s>
|-
|}
|}

Latest revision as of 10:53, 15 November 2022

Barion API: Initiate a bank transfer

POST /v2/Withdraw/BankTransfer

The /withdraw/banktransfer API endpoint is used to send money out of the Barion system via bank (wire) transfer.

Prerequisites before use:

WARNING
This API endpoint is obsolete as of August 2022. Please implement or migrate to /v3/Withdraw/BankTransfer
IMPORTANT
Starting September 2022 this API endpoint does NOT accept withdrawal requests in CZK currency that are targeted outside of Czechia.

v2 This API endpoint is available in API v2 only.

Authentication

Barion Wallet Authentication

Input properties

Property name Property type Limitations and constraints Description
Currency string
  • Required
  • Required length: 3 characters
  • Accepted values:
    • "CZK" (Czech crown)
    • "EUR" (Euro)
    • "HUF" (Hungarian forint)
    • "USD" (U.S. dollar)
 The currency of the bank transfer.

Note: Barion does not do currency rate conversion. The caller must have an active account with the selected currency, and must ensure that the target bank accepts the selected currency. Note: Withdraws in CZK currency that are targeted outside of Czechia are not supported on this endpoint starting September 2022.

Amount decimal
  • Required
  • Must be greater than zero
 The total amount to withdraw, excluding fees.
RecipientName string
  • Required
 The name of the recipient of the bank transfer.
Comment string
  • Optional
  • Maximum length: 90 characters
 The comment of the bank transfer.
BankAccount BankAccount
  • Required
 Information about the recipient's bank account.

Output properties

Property name Property type Description
TransactionId Guid The unique identifier of the bank transfer, generated by the Barion system.
Currency string The currency of the bank transfer.
Amount decimal The total amount transferred.
RecipientName string The name of the recipient of the transfer.
Comment string The comment of the bank transfer
BankAccount BankAccount The bank account data.

Possible error responses

Error code Description
ModelValidationError This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.
AuthenticationFailed The provided authentication is not correct.
MinimumWithdrawAmountNotReached The amount specified does not reach the minimum bank transfer amount. This is not in production yet
InvalidCharacter One of the characters is invalid for the bank transfer process
InvalidAccount There is no account belonging to the user with the specified currency.
InappropriateVerificationLevel The user does not have the verification level to be able to transfer.
InvalidCurrency The system does not support the specified currency
InvalidCountry The Country specified in the BankAccount field is invalid.
LowBalance There are not enough funds to cover the withdraw amount and the fee.
BankAccountNumberBlackListed The target bankaccount number is on blacklist, the withdraw process is terminated and the customer gets suspended.
UserIsOverWithdrawLimit The withdraw amount exceeded the allowed limit for non-verified customers, the withdraw process is terminated and the customer gets suspended.
UserIsDeleted The user is deleted from the system, the withdraw is not possible.
UserIsSuspended The user is suspended until the suspension is lifted no withdraws are allowed.
WithdrawFromCustomerAccountToSystemAccount Withdraw to the specified target account is not allowed.
BankAccountNumberNotAllowed Target Bank account number not in the list of allowed bank account numbers for this account.
InternalServerError Something unexpected happened
UnsupportedWithdraw In the case of foreign CZK transfers (targeted outside of Czechia) this endpoint is not suitable to start the transfer. Please upgrade to the v3 version.

Bank transfer amount limitations

Currency Target country Amount limitation
HUF Anywhere No limitation
EUR Anywhere No limitation
USD Anywhere No limitation
CZK Czechia No limitation
CZK Not Czechia Minimum 100 CZK

Bank transfer character limitations

Currency Target country Character limitation
HUF Anywhere No limitation
EUR Anywhere No limitation
USD Anywhere No limitation
CZK Czechia Allowed characters: 
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, á, ä, č, ď, é, ě, í, ľ, ň, ó, ô, ö, ř, ŕ, š, ť, ú, ů, ü, ý, ž, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, Á, Ä, Č, Ď, É, Ě, Í, Ľ, Ň, Ó, Ô, Ö, Ř, Ŕ, Š, Ť, Ú, Ů, Ü, Ý, Ž, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, ', +, !, ", #, $, %, &, *, ;, <, =, >, @, [, ], ^, `, {, |, }, ~, §, SPACE
CZK Not Czechia Allowed characters: 
a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, /, -, ?, :, (, ), ., ,, ', +, SPACE
Retrieved from "https://docs.barion.com/index.php?title=Withdraw-BankTransfer-v2&oldid=3737"