Withdraw-BankTransfer-v2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 95: | Line 95: | ||
|} | |} | ||
== Possible error responses == | == Possible error responses == | ||
Line 107: | Line 106: | ||
|- | |- | ||
| MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum withdraw amount. | | MinimumWithdrawAmountNotReached || The amount specified does not reach the minimum withdraw amount. | ||
|- | |||
| InvalidCharacter || One of the characters is invalid for the withdraw process | |||
|- | |- | ||
|} | |} |
Revision as of 07:05, 24 August 2018
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:
v2 This API endpoint is available in API v2 only.
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 withdraw amount. |
InvalidCharacter | One of the characters is invalid for the withdraw process |