Withdraw-BankTransfer-v3: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
mNo edit summary
(change auth description)
Line 13: Line 13:
* [[Creating_an_account|Creating an account in Barion]]
* [[Creating_an_account|Creating an account in Barion]]
* [[Calling_the_API|Calling the Barion API]]
* [[Calling_the_API|Calling the Barion API]]
* [[Barion Wallet Authentication]]




<span class="api-ver">v3</span> This API endpoint is available in '''API v3'''.
<span class="api-ver">v3</span> This API endpoint is available in '''API v3'''.
== Authentication ==
Barion users are authenticated either with username/password provided in the querystring or with basic authentication. You can find more information about basic authentication [[Basic_authentication|here]]


== 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.
|-
|-


Line 126: Line 110:
| ModelValidationError || This happens when some of the input properties fail the basic validation. For example a string property exceeds its allowed length.
| 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.
| 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'''
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum bank transfer amount. '''This is not in production yet'''

Revision as of 10:15, 15 November 2022

Barion API: Initiate a bank transfer

POST /v3/Withdraw/BankTransfer

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

Prerequisites before use:


v3 This API endpoint is available in API v3.

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.

Amount decimal
  • Required
  • Must be greater than zero
The total amount to withdraw, excluding fees.
Comment string
  • Optional
  • Maximum length: 90 characters
The comment of the bank transfer.
BankAccount BankAccountDetails
  • Required
Information about the recipient's bank account.
Bank BankDetails
  • Required for foreign withdrawals
Information about the recipient's bank.
Recipient RecipientDetails
  • Required
Information about the recipient.

Example requests

Withdraw-BankTransfer-v3-examples

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.
Comment string The comment of the bank transfer
BankAccount BankAccountDetails Information about the recipient's bank account.
Bank BankDetails Information about the recipient's bank.
Recipient RecipientDetails Information about the recipient.

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

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