Withdraw-BankTransfer-v2
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 Withdraw/BankTransfer v3
IMPORTANT
As of September 2022 this API endpoint does NOT accept withdrawal requests in CZK currency.
v2 This API endpoint is available in API v2 only.
Authentication
Barion users are authenticated either with username/password provided in the query string or with basic authentication. You can find more information about basic authentication here
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| UserName | string |
|
Your e-mail address in the Barion system. |
| Password | string |
|
Your password in the Barion system. |
| Currency | string |
|
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. |
| Amount | decimal |
|
The total amount to withdraw, excluding fees. |
| RecipientName | string |
|
The name of the recipient of the bank transfer. |
| Comment | string |
|
The comment of the bank transfer. |
| BankAccount | BankAccount |
|
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 UserName or Password are 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 |
| SOON 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 |