Withdraw-BankTransfer-v2: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 51: | Line 51: | ||
* Required | * Required | ||
|| Information about the recipient's bank account. | || Information about the recipient's bank account. | ||
|} | |||
= Output properties = | |||
{{api_output_table_header}} | |||
|- | |||
| 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. | |||
|} | |} | ||
Revision as of 11:36, 6 February 2017
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 |
|---|---|---|---|
| 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. |
| Currency | 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. |